Opened 13 years ago

Closed 7 years ago

#55 closed task (fixed)

Change to Doxygen (javadoc) code commenting

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

Description (last modified by stevenhl)

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 13 years ago by stevenhl

  • Description modified (diff)
  • Owner changed from StevenHL to stevenhl
  • Status changed from new to assigned
  • Summary changed from Change to Javadoc code commenting to Change to Doxygen (javadoc) code commenting

comment:2 Changed 13 years ago by stevenhl

  • Type changed from enhancement to task

comment:3 Changed 13 years ago by stevenhl

  • Owner stevenhl deleted
  • Status changed from assigned to new

comment:4 Changed 13 years ago by stevenhl

  • Owner set to noone

comment:5 Changed 13 years ago by stevenhl

  • Owner noone deleted

comment:6 Changed 12 years ago by gyoung

  • Milestone set to Release_4.0

comment:7 Changed 11 years ago by gyoung

  • Component changed from fm/2 base to Documentation

comment:8 Changed 8 years ago by gyoung

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

comment:9 Changed 7 years ago by gyoung

  • Milestone set to Release_3.21

comment:10 Changed 7 years ago by gyoung

  • Owner set to gyoung
  • Status changed from new to assigned

comment:11 Changed 7 years ago by gyoung

  • Resolution set to fixed
  • Status changed from assigned to closed

CS 1673

Note: See TracTickets for help on using tickets.