Ticket #755 (new task)

Opened 4 years ago

Last modified 2 years ago

Complete API documention

Reported by: dgollub Owned by: dgollub
Priority: normal Milestone: OpenSync 0.40
Component: OpenSync: API Documentation Version: 0.38
Severity: normal Keywords:
Cc:

Description

There are still several gaps in API documentation. Doxygen is able to determine where API documentation is wrong/missing if Doxygen is instrumented in the code. This is not always the case. We need full Doxygen coverage as well.

How to generate doxygen documentation 

cmake -DBUILD_DOCUMENTATION=true /path/to/opensync/source/
make DoxygenDoc
less doxygen.log

The doxygen logfile doxygen.log gives warnings about wrong/missing documentation. First step would be to instrument each file with the Doxygen base, so we get for each file warnings.

Attachments

doxygen.log Download (83.5 KB) - added by bricks 2 years ago.

Change History

comment:1 Changed 4 years ago by dgollub

  • Milestone changed from 0.37 to 0.40

comment:2 Changed 3 years ago by tuju

  • Version changed from 0.36 to 0.38

comment:3 Changed 3 years ago by bricks

Added the current doxygen log file

comment:4 Changed 3 years ago by bricks

All doxygen warnings (which aren't caused by missing documentation) are fixed in r5189

comment:5 Changed 2 years ago by dgollub

  • Component changed from OpenSync to OpenSync: API Documentation

Is this ticket still valid?

Changed 2 years ago by bricks

comment:6 Changed 2 years ago by bricks

Yes it is. More the ever ...

Note: See TracTickets for help on using tickets.