Project

General

Profile

Actions

Bug #2572

closed

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

Added by laforge over 6 years ago. Updated about 6 years ago.

Status:
Closed
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)Closedmsuraev10/11/2017

Actions
Actions #1

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.

Actions #2

Updated by msuraev over 6 years ago

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

Actions #3

Updated by msuraev over 6 years ago

  • % Done changed from 0 to 40

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

Actions #4

Updated by msuraev over 6 years ago

Still need to figure out what puts docs on ftp.

Actions #5

Updated by msuraev over 6 years ago

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

Updated by msuraev over 6 years ago

Actions #7

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.

Actions #8

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.

Actions #9

Updated by msuraev over 6 years ago

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

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

Actions #11

Updated by laforge about 6 years ago

  • Status changed from Resolved to Closed
Actions

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)