[SINGA-420] C++ Documentation out of date

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Moaz Reyad
• Created: 17/Dec/18 15:16
• Updated: 22/Apr/19 10:37
• Resolved: 01/Apr/19 08:39

Description

There is a link to SINGA C++ documentation on the main page that points to an old C++ API. This API was generated on Thu Feb 9 2017.

The API should be updated since the C++ code was changed many times since Feb 2017.

I suggest to move the C++ documentation to the ASF site and to generate it automatically by adding the doxygen command in build.sh.

Please note that the C++ documentation is not complete. There are missing documentation to be completed to increase the documentation coverage.

This issue is also related to SINGA graduation from the incubator. Since complete and updated documentation is useful for graduation.

Issue Links

• is related to: SINGA-336 Complete C++ documentation
• relates to: SINGA-405 Graduate Apache SINGA (incubating) as a TLP
• links to: GitHub Pull Request #447