Changes between Initial Version and Version 1 of Developer/Coding/Boilerplate_File_Header


Ignore:
Timestamp:
05/29/14 23:57:20 (10 years ago)
Author:
Gedare
Comment:

/* New page */ Refactored from Coding Conventions.

Legend:

Unmodified
Added
Removed
Modified

  • Developer/Coding/Boilerplate_File_Header

    v1 v1  
     1= Boilerplate File Header =
     2
     3
     4
     5Every file should include two comment header blocks, one for the Doxygen output and a copyright notice.  This is a typical example:
     6{{{
     7/**
     8 * @file
     9 *
     10 * @ingroup TheGroupForThisFile
     11 *
     12 * @brief Short "Table of Contents" Description of File Contents
     13 *
     14 * A short description of the purpose of this file.
     15 */
     16
     17/*
     18 * COPYRIGHT (c) 1989-2012.
     19 * On-Line Applications Research Corporation (OAR).
     20 *
     21 * The license and distribution terms for this file may be
     22 * found in the file LICENSE in this distribution or at
     23 * http://www.rtems.com/license/LICENSE.
     24 */
     25}}}
     26
     27 *  Use exactly one blank line between the Doxygen header and copyright notice. Leave the first line of the copyright notice blank.
     28 *  Separate the Doxygen header and copyright notice so the copyright notice is not included in the Doxygen output.
     29 *  The copyright owner and specific license terms may vary.