objective-c - Objective-C：headerdoc2html 不生成协议文档

Question

我尝试通过 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

Answer 1

我觉得您的代码是完美的，但是当涉及到错误的 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”文件到父文件。现在您可以打开它并测试您的项目。