Create man pages for my own C library

Question

In some C-source file I've seen comments in the format:

/**
 *  @bla bla bla
 *  bla bla..
 */

Someone told me that if I comment my .c / .h files properly, then with a certain tool I can autogenerate man pages from those files automatically.

Does anybody know if this is possible? (How to do, which software should I use, etc.)

score 6 · Accepted Answer · edited Dec 16 '18 at 14:12

6

It looks like you are searching for doxygen

edited Dec 16 '18 at 14:12

albert

8,285
3
19
32

answered Aug 08 '12 at 13:09

RageD

6,693
4
30
37

score 3 · Answer 2 · edited Dec 16 '18 at 14:13

3

Those comments you see are probably doxygen markup. That can produce man, HTML, and a variety of other formats.

edited Dec 16 '18 at 14:13

albert

8,285
3
19
32

answered Aug 08 '12 at 13:10

chrisaycock

36,470
14
88
125

score 2 · Answer 3 · edited Dec 16 '18 at 14:12

2

Try doxygen

http://www.doxygen.nl/index.html

The syntax you showed is doxygen. AFAIK, it can generate man pages (and HTML and LaTeX).

edited Dec 16 '18 at 14:12

albert

8,285
3
19
32

answered Aug 08 '12 at 13:09

Josh Petitt

9,371
12
56
104

Create man pages for my own C library

3 Answers3