WYSIWYG in Doxygen

Posted by Adam Shiemke on Stack Overflow See other posts from Stack Overflow or by Adam Shiemke
Published on 2010-05-28T15:50:07Z Indexed on 2010/05/28 15:52 UTC
Read the original article Hit count: 301

I'm working on a fairly large project written in C. The idea was to build a library of modular blocks that can be reused across several platforms. Each module is assocaited with a word document in .docx format (huge pain to diff-merge). In these docs, an interface section is specified, listing datatypes and publicly accessable functions. These were often inconsistant with the actual implementation in code, and wading through all this documentation was a pain.

I've been working to switch to doxygen to simplify document managemnet. I haven't found a good way to embed the previously written documentation into the doxygen output. I've copy-pasted them into sections and used modules to group the sources together, but the document sections look ugly in the comments (the output is pretty) and since doxygen takes a while to parse through our code (about 30 mins), validating formatting is a pain.

Is there some way to WYSIWIG large blocks of documentation into doxygen? I feel this would improve the number of people documenting their code, and the quality of that documentation. I considered linking to html, but that splits out the documentation. I also considered putting them inline in html, but this also seems like a pain and would mean everyone needs a WYSIWIG HTML edditor (or some html skillz).

Any ideas on how to make things easier and prettier?

Thanks loads.

© Stack Overflow or respective owner

Related posts about c

    Related posts about documentation