Changes between Version 3 and Version 4 of Developer/Coding/Conventions


Ignore:
Timestamp:
Nov 8, 2012, 4:32:18 AM (7 years ago)
Author:
JoelSherrill
Comment:

/* File Issues */ Enhance to add Doxygen

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Conventions

    v3 v4  
    1313 *  Every file should include a header with the copyright notice.  This is a typical example:
    1414{{{
     15/**
     16 * @file
     17 * @brief short "Table of Contents" description of code
     18 *
     19 * A short description of the purpose of this file.
     20 */
     21
    1522/*
    16  *  COPYRIGHT (c) 1989-2007.
     23 *  COPYRIGHT (c) 1989-2012.
    1724 *  On-Line Applications Research Corporation (OAR).
    1825 *
     
    2532 *  Do not put unrelated functions or data in a single file.  This results in object code bloat.
    2633 *  If adding code to ''cpukit'' be sure the filename is unique since it will be merged all code under that directory gets merged into a single library.
     34 *  The Doxygen header block is separate from the copyright notice intentionally so the copyright notice is not included in the Doxygen output.
     35 *  The copyright owner and specific license terms may vary. The above is typical and the preferred license but BSD, "use as is" and others are acceptable.  Pure GPL licensed code is NOT acceptable.
    2736= Source Code Style =
    2837