Moaz Reyad created SINGA-336:
--------------------------------
Summary: Complete C++ documentation
Key: SINGA-336
URL: https://issues.apache.org/jira/browse/SINGA-336
Project: Singa
Issue Type: Bug
Components: Documentation
Reporter: Moaz Reyad
Priority: Critical
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:
# 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
{code}
INPUT = ../include ../build/include
{code}
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.
# 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.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)