Changes between Initial Version and Version 1 of GCI/Documentation/FileHeaders


Ignore:
Timestamp:
11/17/15 19:31:26 (8 years ago)
Author:
Gedare Bloom
Comment:

Import from GCI/Projects

Legend:

Unmodified
Added
Removed
Modified

  • GCI/Documentation/FileHeaders

    v1 v1  
     1= Fix File Headers =
     2
     3[[TOC(GCI/Documentation/FileHeaders , depth=2)]]
     4
     5
     6This is very similar to the task [wiki:GCI/Documentation/Doxygen Add Doxygen File Headers] except that you are working with a .h file. It should have a comment block at the top that is like this:
     7
     8''Desired Format''':
     9{{{
     10/**
     11 * @file
     12 *
     13 * @brief Brief Description for Table of Contents
     14 *
     15 * Optional paragraph
     16 */
     17
     18/*
     19 *  COPYRIGHT...
     20 */
     21}}}
     22
     23Many are missing the comment block entirely, others are missing the @brief, etc.
     24
     25See the Add Doxygen File Headers task for further guidance on patching, format, review, etc.