Question

I am trying to create a documentation for a complex c++ project.

为此,我开始使用适合我使用的Doxygen,因为我只得对我的项目负责人发表评论,以获得超文本文件。这些文件是完美的,具有良好的风格。

But here is my problem I want to get this documentation in a Markdown file to be able to push it on Gitlab.

我试图用 m氧气将Xml文档转换为 m。它运作良好,但并不像我所希望的那样适当:由微氧自动产生的根基没有发挥作用。介绍也是一个问题,例如,它把定义清单放在文件上的位置上,因为文件很长,而且最有用。

I would like to know then if there is a way to document my code as simply as using Doxygen but getting a proper markdown file ( anchors working and better template) .

I know the markdown syntax is simple but i can t write the whole markdown by myself because the project is big and is going to be updated often so i need a generic method to get documentation in markdown from a C++ project.

Answer 1

I ran into a similar problem some time ago, and it was not easy to solve. Basically what I did is to convert the documentation to LaTeX, and from there, to markdown. Check this to the LaTeX->Markdown passage (other tools existe as well).

You can automate the process using make/latexmke to some point, but I personally have not been able to make the process easy and I still need to step in sometimes. Also note that you might need to use other tools, like flex, to make your LaTeX document into one big tex file. Some conversion programs do not accept split tex files.

This is not perfect, but it might give you another angle at this. Hope it helps.

Answer 2

Markdown support was introduced in Doxygen version 1.8.0.

友情链接