Re: [Doxygen-users] Utilizing Doxygen for collaborative document building
Brought to you by:
dimitri
From: Mark <dox...@er...> - 2017-05-05 00:34:08
|
> On May 5, 2017, at 2:26, Molly McAllister <mol...@uc... <mailto:mol...@uc...>> wrote: > > The document will include the scientific description plus some of the technical code structure (and explanation) of a model. At the moment it is in pdf format and needs to be updated and edited to include more overview information with graphics as well as code structure, explanation, and snippets. It needs to eventually be hosted on the web, so ultimately html format. Would doxygen be good for this? > > I work on a team and the idea was to have specialists edit their respective sections. So maybe the document would live in doxygen and multiple people could edit it some how. I think you’d be better off using Asciidoctor (Asciidoc superset that is actively supported) for this plus the aforementioned git, or other versioning system. You can put code (you do mean source code?) fragments into Asciidoctor and have them syntax highlighted in the output. Doxygen is for when you want your readers to be able to explore the code structure or get reference information about use of an API. Regards -Mark |