[SINGA-336] Complete C++ documentation

• Type: Bug
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Moaz Reyad
• Created: 23/Oct/17 06:48
• Updated: 17/Dec/18 15:19

Description

The documentation of C++ classes is not complete.

Improving the C++ documentation will help developers to contribute improvements and bug fixes in the core modules. It will also help users to understand how SINGA works and it will enrich the overall system documentation.

There are two problems here:

1. The doxygen documentation is set only for two include directories while ignoring all C++ classes in other directories:

https://github.com/apache/incubator-singa/blob/master/doc/Doxyfile#L107

INPUT                  = ../include ../build/include

This can be solved either by adding other directories to Doxygen input, or moving the header files (for example from src/model/layer) to /include if we want to avoid storing header files under /src.

1. The coverage of the C++ documentation now is only 42.1 % as measured by coverxygen tool.

This does not take into account also the missing classes which are not currently in the doxygen input.

Issue Links

• relates to: SINGA-420 C++ Documentation out of date