文章/答案/技术大牛

发布

社区首页 >问答首页 >Objective-C: headerdoc2html不为协议生成文档

问Objective-C: headerdoc2html不为协议生成文档
EN

Stack Overflow用户

提问于 2012-09-14 16:15:45

回答 1查看 964关注 0票数 0

我试着用headerdoc2html命令生成文档。但是headerdoc只生成toc.html。协议没有index.html。有什么问题吗？

我使用了下面的头文件和命令。

/*!                                                                                                                                                                                                                                                                             
  @header Dummy.h                                                                                                                                                                                                                                                               
  hoge                                                                                                                                                                                                                                                                          
*/                                                                                                                                                                                                                                                                              


/*!                                                                                                                                                                                                                                                                             
  @class Foo                                                                                                                                                                                                                                                                    
  asdf                                                                                                                                                                                                                                                                          
*/                                                                                                                                                                                                                                                                              
@interface Foo : NSObject                                                                                                                                                                                                                                                       

/*!                                                                                                                                                                                                                                                                             
  @abstract xxx                                                                                                                                                                                                                                                                 
*/                                                                                                                                                                                                                                                                              
- (void)xxx;                                                                                                                                                                                                                                                                    

@end                                                                                                                                                                                                                                                                            

/*!                                                                                                                                                                                                                                                                             
  @protocol BarDelegate                                                                                                                                                                                                                                                         
*/                                                                                                                                                                                                                                                                              
@protocol BarDelegate                                                                                                                                                                                                                                                           

/*!                                                                                                                                                                                                                                                                             
  @abstract Sent after something                                                                                                                                                                                                                                                
*/                                                                                                                                                                                                                                                                              
- (void)didSomething:(Foo *)foo;                                                                                                                                                                                                                                                
@end

$ headerdoc2html *.h -o doc

结果是，

$ find doc
doc
doc/Dummy_h
doc/Dummy_h/Classes
doc/Dummy_h/Classes/Foo
doc/Dummy_h/Classes/Foo/index.html
doc/Dummy_h/Classes/Foo/toc.html
doc/Dummy_h/index.html
doc/Dummy_h/Protocols
doc/Dummy_h/Protocols/BarDelegate
doc/Dummy_h/Protocols/BarDelegate/toc.html
doc/Dummy_h/toc.html

objective-c

documentation

header-files

回答 1

Stack Overflow用户

发布于 2016-10-16 13:38:26

我觉得你的代码是完美的，但是说到commad，那就错了。创建headerDoc有四个步骤。

步骤1:转到项目所在的目录(而不是您所做的头文件)。

$ cd <Your_Project_Directory>

步骤2:现在创建项目所有控制器的HTML DOC文件，并创建一个目录，您将在其中生成HTML DOC文件。

<Your_Project_Directory> $ headerdoc2html -o <DIR_PATH_TO_CREATE_YOUR_DOC> <PROJECT_NAME>

步骤3:现在您将看到它们是在您创建doc文件的目录路径中创建的内容。不要想太多，我们稍后会看到的。现在转到创建HTML文件的目录

<Your_Project_Directory> $ cd <DIR_PATH_TO_CREATE_YOUR_DOC>

步骤4:他们现在在你的目录中有这么多的文件，所有的文件都是彼此分开的，所以为了把它们放在一起并创建彼此的链接，你必须应用最后一个命令。

gatherheaderdoc ..

这里最后的‘..’(两个点)将创建父文件的"masterTOC.HTML“文件。现在您可以打开它并测试您的项目。

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/12420550

复制

相似问题

问Objective-C: headerdoc2html不为协议生成文档
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Objective-C: headerdoc2html不为协议生成文档EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Objective-C: headerdoc2html不为协议生成文档
EN