xcode 如何使用 Apple Header doc 为 iOS 开发自动生成文档?

声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow 原文地址: http://stackoverflow.com/questions/7581208/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me): StackOverFlow

提示:将鼠标放在中文语句上可以显示对应的英文。显示中英文
时间:2020-09-14 22:02:57  来源:igfitidea点击:

How to use Apple Header doc for auto-generated documentation for iOS development?

iosxcodedocumentationdoxygenautodoc

提问by Mrunal

I have used Doxygen tool for document generation. But later on I have come to know that Apple itself provides "Documentation Set Guide".

我使用 Doxygen 工具生成文档。但是后来我才知道,Apple 本身提供了“文档集指南”。

Here is the reference link: http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/Documentation_Sets/000-Introduction/introduction.html#//apple_ref/doc/uid/TP40005266-CH1-SW1

这是参考链接:http: //developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/Documentation_Sets/000-Introduction/introduction.html#//apple_ref/doc/uid/TP40005266-CH1-SW1

Is there anyone aware about this - how to use this and all? Whether it would be useful for autogenerated document creation?

有没有人知道这一点 - 如何使用这个和所有?它是否对自动生成的文档创建有用?

Thanks in advance,

提前致谢,

Mrunal

穆纳尔

回答by doxygen

'docsets' are merely a way to package documentation and show it in XCode. Doxygen has support for docsets, see http://developer.apple.com/library/mac/#featuredarticles/DoxygenXcode/_index.htmland http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/and http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-ii/

'docsets' 只是一种打包文档并在 XCode 中显示的方法。Doxygen 支持文档集,请参阅 http://developer.apple.com/library/mac/#featuredarticles/DoxygenXcode/_index.htmlhttp://www.duckrowing.com/2010/03/18/documenting-objective- c-with-doxygen-part-i/http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-ii/

If you want a tool that mimics Apples output (and care less about the features provided by doxygen) you could have a look at appledoc http://www.gentlebytes.com/home/appledocapp

如果您想要一个模仿 Apples 输出的工具(并且不太关心 doxygen 提供的功能),您可以查看 appledoc http://www.gentlebytes.com/home/appledocapp

回答by ruipacheco

Apple has it's own documentation generation tool. It's called HeaderDoc.

Apple 有自己的文档生成工具。它被称为HeaderDoc