singa-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SINGA-420) C++ Documentation out of date
Date Mon, 22 Apr 2019 10:38:00 GMT

    [ https://issues.apache.org/jira/browse/SINGA-420?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16823000#comment-16823000
] 

ASF subversion and git services commented on SINGA-420:
-------------------------------------------------------

Commit 1857944 from Moaz Reyad in branch 'site/trunk'
[ https://svn.apache.org/r1857944 ]

SINGA-420 Add Doxygen C++ documentation

> C++ Documentation out of date
> -----------------------------
>
>                 Key: SINGA-420
>                 URL: https://issues.apache.org/jira/browse/SINGA-420
>             Project: Singa
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Moaz Reyad
>            Priority: Major
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
> There is a link to SINGA C++ documentation on the [main page|http://singa.apache.org/]
that points to an old [C++ API|https://www.comp.nus.edu.sg/~dbsystem/singa/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|https://svn.apache.org/repos/asf/incubator/singa/site/]
and to generate it automatically by adding the doxygen command in [build.sh|https://github.com/apache/incubator-singa/blob/master/doc/build.sh].
> Please note that the [C++ documentation is not complete|https://issues.apache.org/jira/browse/SINGA-336].
There are missing documentation to be completed to increase the documentation coverage.
> This issue is also related to [SINGA graduation from the incubator.|https://issues.apache.org/jira/browse/SINGA-405]
Since complete and updated documentation is useful for graduation.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message