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


Ignore:
Timestamp:
Sep 12, 2018, 7:38:39 PM (10 months ago)
Author:
Gedare Bloom
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GCI/Documentation/DoxygenCleanup

    v5 v6  
    1 = Doxygen =
     1= Doxygen Clean-up =
    22
    3 [[TOC(GCI/Documentation/Doxygen , depth=5)]]
    4 
    5 
    6 == Doxygen ==
    7 
    8 
    9 == Cleanup Doxygen ==
     3[[TOC(GCI/Documentation/DoxygenCleanup , depth=5)]]
    104
    115The cleanup tasks consist of changes to make Doxygen use consistent with the [wiki:Developer/Coding/Doxygen Doxygen Recommendations]. The submission consists of a patch ("diff"), and the student's name and email address for the commit message.
     6
     7== Directions for Students ==
     8
     9For all tasks related to improved RTEMS "Doxygenation"; you should also read through [wiki:Developer/Coding/Doxygen Doxygen Recommendations].
    1210
    1311Students will submit a patch generated by git. You can do this with a git command similar to:
     
    1513$ git diff > gci-doxygen-taskXYZ.diff
    1614}}}
     15
    1716=== Use sentences for function @brief ===
    1817
     
    8079
    8180
    82 === Mentor Guidelines ===
    83  The student will submit a patch that should be reviewed for correctness. When correct, if the mentor doesn't have git write permission, they should post the patch to rtems-devel. If the mentor does have write permission, they are free to commit it. In either case, we need the student's name and email to give credit in the commit message.
     81== Directions for Mentors ==
     82 The student will submit a patch that should be reviewed for correctness. When correct, if the mentor doesn't have git write permission, they should post the patch to devel. If the mentor does have write permission, they are free to commit it. In either case, we need the student's name and email to give credit in the commit message.
    8483