[CMake] Suggestions on documenting my CMake modules

Alexander Neundorf a.neundorf-work at gmx.net
Mon Oct 31 17:14:19 EDT 2011


On Monday 31 October 2011, Rolf Eike Beer wrote:
> Am Montag, 31. Oktober 2011, 20:58:45 schrieb Alexander Neundorf:
> > On Saturday 29 October 2011, Robert Dailey wrote:
> > > I have several complex functions which require a ton of documentation.
> > > I wanted to type this documentation directly in the cmake file right
> > > above the function() itself, but it is turning out to be a formatting
> > > nightmare.
> > > 
> > > What would you guys recommend as far as this kind of documentation
> > > goes? It would be great if doxygen could scan CMake scripts and
> > > generate HTML documentation out of them, but I don't know if this is
> > > possible. Also, typing up the documentation in a wiki externally would
> > > ease the formatting but would require people to go to an external
> > > source for documentation that would otherwise be immediately available
> > > in the code itself.
> > 
> > A patch to add some more formatting options to the cmake docs would be
> > welcome
> > 
> > :-)
> > 
> > Like e.g. *bold*, _italic_ and something for preformatted text.
> 
> Just that your /italic/ was _underlined_.

Also good :-)
Different wikis do different things...

Alex


More information about the CMake mailing list