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


Ignore:
Timestamp:
Nov 22, 2018, 4:21:36 PM (7 months ago)
Author:
Abhimanyu Raghuvanshi
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen

    v25 v26  
    1414=  Special Notes for Google Code In Students  =
    1515
    16  *  Follow the directions given by the [wiki:GCI Google Code In] task and this should take care of itself, if in doubt ask a mentor and/or tell a mentor the decision you made.
     16 *  Follow the directions given by the [wiki:GCI Google Code In] task and this should take care of itself if in doubt ask a mentor and/or tell a mentor the decision you made.
    1717
    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 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/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.
    2121
    2222=  Header blocks  =
     
    322322}}}
    323323
    324 The @a indicates that the next word is a function argument and deserves some kind of high-lighting. However, we feel that @a buries the usage of function arguments within description text. In RTEMS sources, we prefer to use @param instead of @a.
     324The @a indicates that the next word is a function argument and deserves some kind of highlighting. However, we feel that @a buries the usage of function arguments within description text. In RTEMS sources, we prefer to use @param instead of @a.
    325325=  Doxyfile Hints  =
    326326
    327327=  Header Files  =
    328328
    329 It is a RTEMS build feature that header files need to be installed in order to be useful. One workaround to generate documentation which allows automatic link generation is to use the installed header files as documentation input. Assume that we have the RTEMS sources in the ''rtems'' directory and the build of our BSP in ''build/powerpc-rtems5/mybsp'' relative to a common top level directory. Then you can configure Doxygen like:
     329It is an RTEMS build feature that header files need to be installed in order to be useful. One workaround to generate documentation which allows automatic link generation is to use the installed header files as documentation input. Assume that we have the RTEMS sources in the ''rtems'' directory and the build of our BSP in ''build/powerpc-rtems5/mybsp'' relative to a common top-level directory. Then you can configure Doxygen like:
    330330
    331331{{{
     
    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 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 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].