Commit Graph

4 Commits

Author SHA1 Message Date
wferi
6853eeaea6
doc related fixups (#421)
* Fix documentation typo in qbrb.h

* Fix section number in doxygen2man manual

* Point Doxygen to our examples

* No HTML documentation anymore
2020-09-25 08:52:36 +01:00
Chrissie Caulfield
6d35611524
doxygen2man: Add option to read copyright line from the header file (#415)
* doxygen2man: Add option to read copyright line from the header file

This should help make builds reproducible.

I tried various methods of getting the date, using 'git' is no use as
it could be run from a tarball, using the file date doesn't work either
so this seems a reasonable compromise.

* man: Use SOURCE_EPOCH to make manpage dates reproducible

Also add build-aux/update-copyright.sh to keep header file
copyright lines up-to-date.

All code taken from knet
2020-09-09 15:06:55 +01:00
Chrissie Caulfield
59a16df610
doxygen2man - Lots of new features & fixes for parsing libqb manpages (#402)
doxygen2man: Lots of fixes and features

a) Make it quieter in normal operation
b) add options for hard coded things (like company name)
c) handle typedef members of structures
d) tidy function pointers in structs
e) get header file name from the XML or commandline
d) Add support for @ref tags in description
e) add support for @note annotations
f) Don't print (null) if there is no @brief description
g) Add include prefix option
h) use strncat rather than strcat
2020-06-22 13:04:16 +01:00
Fabio M. Di Nitto
93f9975617
Doxygen2man (#388)
* doxygen2man: Add utility to generate man pages from doxygen

This is in here from kronosnet so it cna be used by other parts
of the cluster stack.

* [man] drop trailing white spaces

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* [build] cleanup variable names

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* [build] add conditionals to use internal or external doxygen2man

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* Update .gitignore

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

Co-authored-by: Christine Caulfield <ccaulfie@redhat.com>
2020-03-18 10:29:38 +01:00