osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
10
0
Fork 0
Code Issues Releases Wiki Activity

doxygen: also generate documentation for libosmo{sim,usb}

Browse Source 
We do have API documentation for all libraries, excepte these two.

Change-Id: I2ec5803bc219b9ceaf0d52d41a03ab78f580e689
changes/07/31507/3
Vadim Yanitskiy 3 weeks ago committed by fixeria
parent 85e24a6410
commit 94e0af0a6d
10 changed files with 3563 additions and 12 deletions
Show Stats Download Patch File Download Diff File

4
.gitignore vendored
Unescape View File

@ -42,6 +42,8 @@ Doxyfile.vty
Doxyfile.codec
Doxyfile.coding
Doxyfile.gb
Doxyfile.sim
Doxyfile.usb
debian/autoreconf.after
debian/autoreconf.before
@ -83,6 +85,8 @@ doc/vty/doxygen_sqlite3.db
doc/gsm
doc/isdn
doc/gb
doc/sim
doc/usb
doc/html.tar
doc/*.tag
doc/*.tag.prep

1716
Doxyfile.sim.in
View File

File diff suppressed because it is too large Load Diff

1716
Doxyfile.usb.in
View File

File diff suppressed because it is too large Load Diff

87
Makefile.am
Unescape View File

@ -150,6 +150,22 @@ $(top_builddir)/doc/libosmogb.tag.prep: $(top_builddir)/Doxyfile.gb \
-$(DOXYGEN) $(top_builddir)/Doxyfile.gb
touch "$@"
$(top_builddir)/doc/libosmosim.tag.prep: $(top_builddir)/Doxyfile.sim \
$(top_srcdir)/include/osmocom/sim/*.h \
$(top_srcdir)/src/sim/*.[hc]
rm -rf $(top_builddir)/doc/sim; mkdir -p $(top_builddir)/doc/sim
rm -rf $(top_builddir)/doc/libosmosim.map
-$(DOXYGEN) $(top_builddir)/Doxyfile.sim
touch "$@"
$(top_builddir)/doc/libosmousb.tag.prep: $(top_builddir)/Doxyfile.usb \
$(top_srcdir)/include/osmocom/usb/*.h \
$(top_srcdir)/src/usb/*.[hc]
rm -rf $(top_builddir)/doc/usb; mkdir -p $(top_builddir)/doc/usb
rm -rf $(top_builddir)/doc/libosmousb.map
-$(DOXYGEN) $(top_builddir)/Doxyfile.usb
touch "$@"
# Build for real once all depending .tag files are in place.
# Depend on the own .tag.prep file to avoid concurrent builds of the same doc
# tree, and to also depend on all the source files listed above.
@ -169,7 +185,9 @@ $(top_builddir)/doc/core/html/index.html: $(top_builddir)/doc/libosmocore.tag.pr
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/core; mkdir -p $(top_builddir)/doc/core
$(DOXYGEN) Doxyfile.core
@ -180,7 +198,9 @@ $(top_builddir)/doc/gsm/html/index.html: $(top_builddir)/doc/libosmogsm.tag.prep
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/gsm; mkdir -p $(top_builddir)/doc/gsm
$(DOXYGEN) Doxyfile.gsm
@ -191,7 +211,9 @@ $(top_builddir)/doc/isdn/html/index.html: $(top_builddir)/doc/libosmoisdn.tag.pr
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/isdn; mkdir -p $(top_builddir)/doc/isdn
$(DOXYGEN) Doxyfile.isdn
@ -203,7 +225,9 @@ $(top_builddir)/doc/vty/html/index.html: $(top_builddir)/doc/libosmovty.tag.prep
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/vty/html $(top_builddir)/doc/vty/latex
$(DOXYGEN) Doxyfile.vty
@ -214,7 +238,9 @@ $(top_builddir)/doc/codec/html/index.html: $(top_builddir)/doc/libosmocodec.tag.
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/codec; mkdir -p $(top_builddir)/doc/codec
$(DOXYGEN) Doxyfile.codec
@ -225,7 +251,9 @@ $(top_builddir)/doc/coding/html/index.html: $(top_builddir)/doc/libosmocoding.ta
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/coding; mkdir -p $(top_builddir)/doc/coding
$(DOXYGEN) Doxyfile.coding
@ -236,7 +264,9 @@ $(top_builddir)/doc/ctrl/html/index.html: $(top_builddir)/doc/libosmoctrl.tag.pr
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/ctrl; mkdir -p $(top_builddir)/doc/ctrl
$(DOXYGEN) Doxyfile.ctrl
@ -247,18 +277,53 @@ $(top_builddir)/doc/gb/html/index.html: $(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/gb; mkdir -p $(top_builddir)/doc/gb
$(DOXYGEN) Doxyfile.gb
$(top_builddir)/doc/sim/html/index.html: $(top_builddir)/doc/libosmosim.tag.prep \
$(top_builddir)/doc/libosmocore.tag.prep \
$(top_builddir)/doc/libosmogsm.tag.prep \
$(top_builddir)/doc/libosmoisdn.tag.prep \
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmousb.tag.prep
rm -rf $(top_builddir)/doc/sim; mkdir -p $(top_builddir)/doc/sim
$(DOXYGEN) Doxyfile.sim
$(top_builddir)/doc/usb/html/index.html: $(top_builddir)/doc/libosmousb.tag.prep \
$(top_builddir)/doc/libosmocore.tag.prep \
$(top_builddir)/doc/libosmogsm.tag.prep \
$(top_builddir)/doc/libosmoisdn.tag.prep \
$(top_builddir)/doc/libosmovty.tag.prep \
$(top_builddir)/doc/libosmocodec.tag.prep \
$(top_builddir)/doc/libosmocoding.tag.prep \
$(top_builddir)/doc/libosmoctrl.tag.prep \
$(top_builddir)/doc/libosmogb.tag.prep \
$(top_builddir)/doc/libosmosim.tag.prep
rm -rf $(top_builddir)/doc/usb; mkdir -p $(top_builddir)/doc/usb
$(DOXYGEN) Doxyfile.usb
if HAVE_DOXYGEN
install-data-hook:
cd $(DESTDIR)$(htmldir) && tar xf html.tar && rm -f html.tar
uninstall-hook:
cd $(DESTDIR)$(htmldir) && rm -rf {core,gsm,isdn,vty,codec,coding,ctrl,gb}
DX_CLEAN = doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb}/html/search/* doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb}/{html,latex}/* doc/html.tar doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb}/doxygen_sqlite3.db doc/*.tag doc/*.tag.prep
cd $(DESTDIR)$(htmldir) && rm -rf {core,gsm,isdn,vty,codec,coding,ctrl,gb,sim,usb}
DX_CLEAN = \
doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb,sim,usb}/html/search/* \
doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb,sim,usb}/{html,latex}/* \
doc/{core,gsm,isdn,vty,codec,coding,ctrl,gb,sim,usb}/doxygen_sqlite3.db \
doc/*.tag.prep \
doc/*.tag \
doc/html.tar \
$(NULL)
endif
MOSTLYCLEANFILES = $(DX_CLEAN)

2
configure.ac
Unescape View File

@ -627,5 +627,7 @@ AC_OUTPUT(
Doxyfile.coding
Doxyfile.gb
Doxyfile.ctrl
Doxyfile.sim
Doxyfile.usb
Makefile
contrib/libosmocore.spec)

34
debian/control vendored
Unescape View File

@ -145,7 +145,9 @@ Depends: ${misc:Depends},
libosmoisdn-doc,
libosmovty-doc,
libosmoctrl-doc,
libosmogb-doc
libosmogb-doc,
libosmosim-doc,
libosmousb-doc
Description: Documentation for the Osmo Core library
This is part of the libosmocore "meta"-library. The libosmocore library
contains various utility functions that were originally developed as part of
@ -334,6 +336,21 @@ Description: Osmo SIM library
.
The libosmosim library in particular contains routines for SIM card access.
Package: libosmosim-doc
Architecture: all
Section: doc
Depends: ${misc:Depends},
libosmosim2,
libjs-jquery
Description: Documentation for the Osmo SIM library
This is part of the libosmocore "meta"-library. The libosmocore library
contains various utility functions that were originally developed as part of
the OpenBSC project, but which are of a more generic nature and thus useful to
(at least) other programs that are developed in the sphere of Free Software /
Open Source mobile communication.
.
This package contains the documentation for the libosmosim library.
Package: libosmousb0
Section: libs
Architecture: any
@ -351,6 +368,21 @@ Description: Osmo USB library
The libosmosub library in particular contains routines for USB device access
via libusb-1.0, integrated into the libosmocore select event loop.
Package: libosmousb-doc
Architecture: all
Section: doc
Depends: ${misc:Depends},
libosmousb0,
libjs-jquery
Description: Documentation for the Osmo USB library
This is part of the libosmocore "meta"-library. The libosmocore library
contains various utility functions that were originally developed as part of
the OpenBSC project, but which are of a more generic nature and thus useful to
(at least) other programs that are developed in the sphere of Free Software /
Open Source mobile communication.
.
This package contains the documentation for the libosmousb library.
Package: libosmocore-dev
Architecture: any
Multi-Arch: same

7
debian/libosmosim-doc.doc-base vendored
Unescape View File

@ -0,0 +1,7 @@
Document: libosmosim-doc
Title: Documentation for the libosmosim library
Section: Programming
Format: HTML
Index: /usr/share/doc/libosmocore/sim/html/index.html
Files: /usr/share/doc/libosmocore/sim/html/*.html

1
debian/libosmosim-doc.install vendored
Unescape View File

@ -0,0 +1 @@
usr/share/doc/libosmocore/sim/

7
debian/libosmousb-doc.doc-base vendored
Unescape View File

@ -0,0 +1,7 @@
Document: libosmousb-doc
Title: Documentation for the libosmousb library
Section: Programming
Format: HTML
Index: /usr/share/doc/libosmocore/usb/html/index.html
Files: /usr/share/doc/libosmocore/usb/html/*.html

1
debian/libosmousb-doc.install vendored
Unescape View File

@ -0,0 +1 @@
usr/share/doc/libosmocore/usb/
Write Preview
Loading…
Cancel
Save