Project

General

Profile

Bug #2572

libosmo-sigtran API documentation not built (no Doxyfille) and not published

Added by laforge 2 months ago. Updated about 2 months ago.

Status:
Resolved
Priority:
High
Assignee:
Target version:
-
Start date:
10/11/2017
Due date:
% Done:

100%

Spec Reference:

Description

We need to
  • 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

Related to libosmo-netif - Bug #2569: libosmo-netif API documentation missing (doxygen) Resolved 10/11/2017

History

#1 Updated by msuraev 2 months 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.

#2 Updated by msuraev 2 months ago

Should it be enabled for old (mtp/sccp) libraries too or only for new sigtran?

#3 Updated by msuraev 2 months ago

  • % Done changed from 0 to 40

Gerrit 4234 adds doc generation (for newer sigtran library only).

#4 Updated by msuraev 2 months ago

Still need to figure out what puts docs on ftp.

#5 Updated by msuraev 2 months ago

  • Related to Bug #2569: libosmo-netif API documentation missing (doxygen) added

#6 Updated by msuraev 2 months ago

#7 Updated by msuraev 2 months 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.

#8 Updated by laforge 2 months 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.

#9 Updated by msuraev 2 months ago

  • Status changed from Feedback to In Progress
  • % Done changed from 60 to 70

#10 Updated by msuraev about 2 months 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

Also available in: Atom PDF