Changes between Version 5 and Version 6 of GCI/Documentation/DoxygenForBSPs


Ignore:
Timestamp:
Nov 5, 2018, 5:31:38 PM (11 months ago)
Author:
Gedare Bloom
Comment:

Add info about creating commits.

Legend:

Unmodified
Added
Removed
Modified
  • GCI/Documentation/DoxygenForBSPs

    v5 v6  
    9393Again, once modules are in place for all BSP's, a module should be defined to house the doxygen documenting the files shared across all BSPs.
    9494
    95 Finally, we have reached a group we can really work with, the specific group of the BSP, in this case arm_raspberrypi. You can work with this module the same way you would for using doxygen in general, and can follow the standard doxygen instructions given here and elsewhere. @defgroup new headers in .h files (remembering @ingroup any new headers you define into the BSP group), move protoypes and function comments to the .h and include @briefs, @ingroup relevant .c files, etc etc. These directions can be found in the section [http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Add_Doxygen_File_Headers Add Doxygen File Headers], and other doxygen reccomendations can be found [http://wiki.rtems.org/wiki/index.php/Doxygen_Recommendations here]
     95Finally, we have reached a group we can really work with, the specific group of the BSP, in this case arm_raspberrypi. You can work with this module the same way you would for using doxygen in general, and can follow the standard doxygen instructions given here and elsewhere. @defgroup new headers in .h files (remembering @ingroup any new headers you define into the BSP group), move protoypes and function comments to the .h and include @briefs, @ingroup relevant .c files, etc etc. These directions can be found in the section [http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Add_Doxygen_File_Headers Add Doxygen File Headers], and other doxygen recommendations can be found [http://wiki.rtems.org/wiki/index.php/Doxygen_Recommendations here]
     96
     97=== Contributing Your Work ===
     98
     99You are expected to [wiki:Developer/Contributing provide a patch] for all the changes you make. Your task should be specific to a single BSP, so we would like you to use a commit message such as:
     100{{{
     101git commit -a -m "arm/raspberrypi: Update Doxygen (GCI 20xx)"
     102}}}
     103Where you would replace arm/raspberrypi by the arch/bsp you modified, and xx by the year of GCI this was done in. You are not required to use your real name and email address in the commit authorship information.
    96104
    97105===  Notes, tips, tricks  ===