Bug #2572
closedlibosmo-sigtran API documentation not built (no Doxyfille) and not published
100%
Description
- add a Doxyfile to the source code + integrate to makefiles
- verify that the resulting documentation is built properly (no doxygen syntax errors)
- make sure that we publish the latest version of that API documentation alongside that of other libraries at ftp://ftp.osmocom.org/api/latest/ by means of jenkins
- link the API docs from this wiki
Related issues
Updated by msuraev over 6 years ago
- Status changed from New to Feedback
How do we publish to ftp://ftp.osmocom.org/api/latest/ ? For example libosmo-netif does have Doxygen files but it does not exist on ftp.
Updated by msuraev over 6 years ago
Should it be enabled for old (mtp/sccp) libraries too or only for new sigtran?
Updated by msuraev over 6 years ago
- % Done changed from 0 to 40
Gerrit 4234 adds doc generation (for newer sigtran library only).
Updated by msuraev over 6 years ago
- Related to Bug #2569: libosmo-netif API documentation missing (doxygen) added
Updated by msuraev over 6 years ago
The API publisher job is at https://jenkins.osmocom.org/jenkins/job/Osmocom_API/
Updated by msuraev over 6 years ago
- % Done changed from 40 to 60
https://jenkins.osmocom.org/jenkins/job/Osmocom_API/ has been modified to build libosmo-sccp. Once gerrit 4234 is merged we can enable docs upload by changing single line. Before closing the ticket we still have to clarify if the API docs for older libraries are necessary.
Updated by laforge over 6 years ago
Hi Max,
On Thu, Oct 12, 2017 at 03:03:40PM +0000, msuraev [REDMINE] wrote:
Should it be enabled for old (mtp/sccp) libraries too or only for new sigtran?
only for libosmo-sigtran.
Updated by msuraev over 6 years ago
- Status changed from Feedback to In Progress
- % Done changed from 60 to 70
Updated by msuraev over 6 years ago
- Status changed from In Progress to Resolved
- % Done changed from 70 to 100
Patch has been merged, wiki update. Docs are available at ftp://ftp.osmocom.org/api/latest/libosmosccp/sccp/html/index.html