views:

143

answers:

2

hi

Is it possible to document configure.ac such that doxygen can pick up embedded comments and produce documentation for options, variables, etc. in generated manuals?

Thanks

A: 

There are contributed Autoconf macros for Doxygen at the Autoconf Archive. Include the DX_INIT_DOXYGEN macro in configure.ac and then automake will create targets such as doxygen-doc for generating various subsets of the documentation.

ptomato
thanks, however I need to document configure.ac itself, rather than produce doxygen-* targets
aaa
Oh. Then I don't know, sorry.
ptomato
+1  A: 

You should comment using Doxygen using comments like ##!, right? I don't think that Doxygen supports comments like that, but you could try to modify Doxygen to accept comments like that, then you can document using usual Doxygen commands @var, @cond, etc.

The modification could be hard, but you can try to modify this file commentcnv.l (starting from @line 319). Maybe you can mail with project developer mailing list.

Luca
actually python documentation uses double hash, maybe I can trick doxygen into treating configure.ac as python/Perl file.Thanks
aaa