Notice: We have migrated to GitLab launching 2024-05-01 see here: https://gitlab.rtems.org/

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


Ignore:
Timestamp:
04/23/08 02:02:15 (16 years ago)
Author:
JoelSherrill
Comment:

new page

Legend:

Unmodified
Added
Removed
Modified

  • Developer/Coding/Doxygen

    v1 v1  
     1= Doxygen Recommendations =
     2
     3
     4RTEMS is much older than [http://www.doxygen.org Doxygen] and the documentation in the .h and .inl files was obviously not written with [http://www.stack.nl/~dimitri/doxygen/manual.html Doxygen markup].  In 2007, [wiki:TBR/User/JoelSherrill JoelSherrill] undertook converting the documentation in the .h and .inl files in the RTEMS SuperCore to Doxygen format.  As a result of this effort, the Doxygen for the CVS version of the RTEMS SuperCore is now built automatically multiple times per day and made available on the RTEMS Website.  In April 2008, [wiki:TBR/User/JoelSherrill JoelSherrill] began to update the Classic API (e.g. cpukit/rtems) .h and .inl files to include [http://www.stack.nl/~dimitri/doxygen/manual.html Doxygen markup]. 
     5
     6This page is currently just a place holder but should include RTEMS Project recommendations on writing Doxygen so we all have consistent results.
     7
     8This is an area in which volunteer activity is highly appreciated.
     9
     10TBD