Opened 18 years ago

Last modified 12 years ago

#55 closed task

Change to Javadoc code commenting — at Initial Version

Reported by: Gregg Young Owned by: StevenHL
Priority: minor Milestone: Release_3.21
Component: Documentation Version:
Keywords: Cc:

Description

If enough contributors request it, I could be convinced to switch to javadoc style comments so that the code could be processed by 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 (0)

Note: See TracTickets for help on using tickets.