Opened 17 years ago
Last modified 11 years ago
#55 closed task
Change to Doxygen (javadoc) code commenting — at Version 1
| Reported by: | Gregg Young | Owned by: | Steven Levine |
|---|---|---|---|
| Priority: | minor | Milestone: | Release_3.21 |
| Component: | Documentation | Version: | |
| Keywords: | Cc: |
Description (last modified by )
If enough contributors request it, I could be convinced to switch to Doxygen/javadoc style comments so that the code could be processed by doxygen. Doxygen/javadoc comments are a bit bulkier than my personal style, but sometimes it's useful to have text descriptions of the parameter and return values.
My preference is to name variables so that it's obvious how they are intended to be used. For example, I much prefer variable names like ok and fail to the generic ret that one often sees.
Change History (1)
comment:1 Changed 17 years ago by
| Description: | modified (diff) |
|---|---|
| Owner: | changed from StevenHL to Steven Levine |
| Status: | new → assigned |
| Summary: | Change to Javadoc code commenting → Change to Doxygen (javadoc) code commenting |
Note: See
TracTickets for help on using
tickets.
