Ticket #24 (new task)

Opened 5 years ago

Last modified 4 years ago

Add APIDOX in all classes

Reported by: diederik Owned by: diederik
Priority: normal Milestone: open
Component: Documentation Version: 1.5-pre2
Keywords: Cc:

Description

We just started with APIDOX, but this is not complete. Currently the network classes and data classes are documented. Most important with APIDOX are:

  • a general description
  • the part in a bigger whole
  • a highlight of some method groups in a class.
  • protocol dumps when applicable.
  • for internal methods, the caller/callee can be useful to mention.

Change History

Changed 5 years ago by diederik

  • type changed from defect to task

Changed 4 years ago by amroth

  • milestone set to Someday

Changed 4 years ago by diederik

  • component changed from Other to Documentation

Changed 4 years ago by diederik

  • priority changed from minor to normal

Changed 4 years ago by diederik

Note the APIDOX can be generated using: 

doxygen Doxyfile
Note: See TracTickets for help on using tickets.