Opened 14 years ago

Closed 8 years ago

#55 closed task (fixed)

Change to Doxygen (javadoc) code commenting

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

Description (last modified by Steven Levine)

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 (11)

comment:1 Changed 14 years ago by Steven Levine

Description: modified (diff)
Owner: changed from StevenHL to Steven Levine
Status: newassigned
Summary: Change to Javadoc code commentingChange to Doxygen (javadoc) code commenting

comment:2 Changed 14 years ago by Steven Levine

Type: enhancementtask

comment:3 Changed 14 years ago by Steven Levine

Owner: Steven Levine deleted
Status: assignednew

comment:4 Changed 14 years ago by Steven Levine

Owner: set to noone

comment:5 Changed 14 years ago by Steven Levine

Owner: noone deleted

comment:6 Changed 13 years ago by Gregg Young

Milestone: Release_4.0

comment:7 Changed 12 years ago by Gregg Young

Component: fm/2 baseDocumentation

comment:8 Changed 9 years ago by Gregg Young

CS 1616 changes a*.c files comments to Doxygen style

comment:9 Changed 8 years ago by Gregg Young

Milestone: Release_3.21

comment:10 Changed 8 years ago by Gregg Young

Owner: set to Gregg Young
Status: newassigned

comment:11 Changed 8 years ago by Gregg Young

Resolution: fixed
Status: assignedclosed

CS 1673

Note: See TracTickets for help on using tickets.