Changes between Version 26 and Version 27 of Developer/Coding/Doxygen


Ignore:
Timestamp:
Dec 3, 2018, 9:44:39 PM (5 months ago)
Author:
Sal
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen

    v26 v27  
    1818=  Header File Example  =
    1919
    20 [https://git.rtems.org/rtems/tree/cpukit/score/include/rtems/score/thread.h thread.h] and [https://git.rtems.org/rtems/tree/cpukit/score/include/rtems/score/threadimpl.h threadimpl.h] should be a good example of how a header file should be written. The following gives details in bits and pieces.
     20[https://git.rtems.org/rtems/tree/cpukit/include/rtems/score/thread.h thread.h] and [https://git.rtems.org/rtems/tree/cpukit/include/rtems/score/threadimpl.h threadimpl.h] should be a good example of how a header file should be written. The following gives details in bits and pieces.
    2121
    2222=  Header blocks  =
     
    407407=  History  =
    408408
    409 RTEMS 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 to convert 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 development 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].
     409RTEMS 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 to convert 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 development 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].