使用doxygen to ^ create ^ readme.md?

发布于 2025-01-31 16:37:12 字数 380 浏览 3 评论 0原文

许多人在源文件本身中记录应用程序,例如 https://github.com/github.com/docopt/docopt/docopt.cpp.cpp.cpp 。本着干燥的精神(不要重复自己),我希望源文档出现在github上的readme.md中(自动从源产生。)我看到了许多有关在输出中包括readme.md在内的用户社区问题文档,但没有其他方式,SRC文档 - > readme.md。 Doxygen似乎是应该拥有此空间的工具,但没有用于Markdown文件的输出格式。

为其他人创建输出格式以降级是有意义的吗?

Many people document applications in the source files themselves, e.g. https://github.com/docopt/docopt.cpp . In the spirit of DRY (don't repeat yourself), I would like source documentation to appear in my README.md on GitHub (auto-generated from the source.) I see many user-community questions about including README.md in output documentation, but nothing about going the other way, src documentation -> README.md. doxygen seems like the tool that should own this space, but has no output formatters for markdown files.

Does it make sense to anybody else to create an output formatter for markdown?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

萝莉病 2025-02-07 16:37:12

显然,这确实是有道理的,并且已经提出过,以及开发了一些螺栓固定解决方案: https://github.com/doxygen/doxygen/issues/6760

Apparently it does make sense, and has been proposed before, as well as some bolt-on solutions developed: https://github.com/doxygen/doxygen/issues/6760

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文