docurium:libgit2项目的Doxygen替代

时间:2024-05-28 21:37:01
【文件属性】:

文件名称:docurium:libgit2项目的Doxygen替代

文件大小:143KB

文件格式:ZIP

更新时间:2024-05-28 21:37:01

Ruby

cur Docurium是Doxygen的轻量替代品。 它从C项目的头文件生成静态HTML。 它的意思是简单,易于浏览且具有git-tag意识。 它仅用于记录您的公共接口,因此仅了解您的头文件。 我构建它是为了替换Doxygen为libgit2项目生成的文档,因此,我目前仅对此进行测试。 因此,仅包含对当前在该项目中使用的功能和关键字的支持才是已知的。 如果您有一个C库项目,请尝试此操作,但有什么不对劲,请提出问题或更佳的是请求请求。 尽管Docurium可以将您的文档生成到一个子目录中,但它是从Web服务器提供的,而不是从本地提供的。 它使用XMLHttpRequest调用,该调用无法在本地完成,因此您不能只在本地打开index.html文件并使其工作-您需要在输出目录中运行网络服务器或将其推送到网站上以正确查看它。 我使用Pow(pow.cx)或GitHub Pages。 用法


【文件预览】:
docurium-master
----.travis.yml(208B)
----bin()
--------cm(2KB)
----docurium.gemspec(1KB)
----LICENCE(1KB)
----Rakefile(323B)
----test()
--------test_helper.rb(905B)
--------docurium_test.rb(7KB)
--------gen_test.rb(378B)
--------parser_test.rb(12KB)
--------fixtures()
----Gemfile(101B)
----site()
--------css()
--------images()
--------shared()
--------index.html(12KB)
--------js()
----TODO.txt(225B)
----.gitignore(24B)
----lib()
--------docurium.rb(19KB)
--------libdetect.rb(545B)
--------docurium()
----README.md(3KB)

网友评论