|Anonymous | Login | Signup for a new account||2018-07-18 06:55 UTC|
|My View | View Issues | Change Log | Roadmap | Doomseeker Issue Support Ranking | Rules | My Account|
|View Issue Details|
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0003248||Doomseeker||[All Projects] Suggestion||public||2017-09-01 17:44||2017-10-07 09:58|
|Target Version||Fixed in Version|
|Summary||0003248: Create or convert libwadseeker API documentation to mdoc/nroff manual page format|
|Description||The libwadseeker library would be nice to come with at least an English manual page, either in mdoc format (*BSD) or nroff (GNU/Linux) which can be read offline with man(1) utility. It should have as much information as possible about programming with the shared library as feasible and found useful. Here's some recommendations for sections to include:|
Sections may be omitted as needed. Even a very minimal man page may be helpful and may be expanded in the future.
The build system should also install it to the appropriate directory (somewhere under /usr/share/man/man3 or similar).
|Steps To Reproduce|
$ man libwadseeker No manual entry for libwadseeker
Assuming libwadseeker is installed as a package (in Debian GNU/Linux, in example).
|Additional Information||Libwadseeker 1.1 API is defined online athttp://doomseeker.drdteam.org/docs/wadseeker_1.1/ [^] and can be used as a base or converted to mdoc fairly straightforward, maybe.|
Including a manual page for the library in Debian GNU/Linux would be preferred, but not seemingly required for packaging.
|I think doxygen has built-in support for manpages generation.|
Yes, Doxygen has manpage output.
I think the correct approach here is to create at least a minimal man page for the Wadseeker API by hand, and/or package the Doxygen documentation HTML or manpage output to a libwadseeker-doc package (in Debian).
I'll certainly look into this later, but until then: If anyone has free time, feel free to assign to yourself and start working on this earlier.
|Only registered users can voice their support. Click here to register, or here to log in.|
|Supporters:||No one explicitly supports this issue yet.|
|Opponents:||No one explicitly opposes this issue yet.|
|2017-09-01 17:44||WubTheCaptain||New Issue|
|2017-09-01 19:12||Zalewa||Relationship added||child of 0003246|
|2017-09-09 19:01||Zalewa||Note Added: 0018252|
|2017-10-05 01:46||WubTheCaptain||Status||new => acknowledged|
|2017-10-05 01:46||WubTheCaptain||Summary||Create or convert libwadseeker API documentation to mdoc/groff manual page format => Create or convert libwadseeker API documentation to mdoc/nroff manual page format|
|2017-10-05 01:46||WubTheCaptain||Description Updated||View Revisions|
|2017-10-07 05:33||WubTheCaptain||Relationship added||related to 0003247|
|2017-10-07 09:58||WubTheCaptain||Note Added: 0018458|
Questions or other issues? Contact Us.
|Copyright © 2000 - 2018 MantisBT Team|