Transition to automatically generated documentation (Doxygen)
-
Historically, the software libraries (mostly C) developed by my group were accompanied with the PDF datasheet, describing the purpose, theory of operation, some block diagrams and API. That documentation was constructed manually in the MS WORD file. Now, we are transitioning to Doxygen to get rid of manual effort required to extract the comments from the sources and put them into the MS word document. This is fairly easy to do, but the problem I have is to put the remainder of the MS Word (purpose of the library, theory of operation, block diagrams etc) into the same CHM generated by Doxygen. Due to huge backlog of the custom written documentation (datasheets in MS word), I cannot afford manual operations. So I am looking for the ways for my output Doxygen CHM to contain: a) Imported MS word theory of operations b) Generated API documentation Is there a way to make MS word document to be a part of the Doxygen project? Is there any way (direct or indirect) to import both the Doxygen API documentation and the MS word into the same CHM automatically? Did anyone face the same or similar problems and what the experience was? Appreciate any comments.
-
Historically, the software libraries (mostly C) developed by my group were accompanied with the PDF datasheet, describing the purpose, theory of operation, some block diagrams and API. That documentation was constructed manually in the MS WORD file. Now, we are transitioning to Doxygen to get rid of manual effort required to extract the comments from the sources and put them into the MS word document. This is fairly easy to do, but the problem I have is to put the remainder of the MS Word (purpose of the library, theory of operation, block diagrams etc) into the same CHM generated by Doxygen. Due to huge backlog of the custom written documentation (datasheets in MS word), I cannot afford manual operations. So I am looking for the ways for my output Doxygen CHM to contain: a) Imported MS word theory of operations b) Generated API documentation Is there a way to make MS word document to be a part of the Doxygen project? Is there any way (direct or indirect) to import both the Doxygen API documentation and the MS word into the same CHM automatically? Did anyone face the same or similar problems and what the experience was? Appreciate any comments.
You could just convert the document to HTML. Its not the best practice and will probably lose some of the document markup, layout or comments but it will work…