HeaderDoc不生成HTML文档

Question

我正在为iOS应用程序开发一个可重用的API组件.我已经完成了API并将其记录下来以headerdoc供将来的用户使用.

现在我想为这些头文件创建HTML页面.所以我在我的项目目录中的终端中执行了以下命令

headerdoc2html -o ~/Desktop/My_Project_Documentation APIFolder/

但是没有创建文档,而是我收到的错误如下:

Skipping. No HeaderDoc comments found.
No default encoding.  Guessing.  If date formats are wrong, try
specifying an appropriate value in the LANG environment variable.
...done

我尝试了各种方法和方法,最后我缩小了问题的范围:

在我的项目开始时,我有类似的东西:

/**
 *  DarkPantherConstants.h
 *  Panther
 *  Created by Midhun on 05/11/14.
 *  Copyright (c) 2014 Midhun. All rights reserved.
 *  Panther Constants are defined in this header file
 */

所以问题在于这个特别的评论,实际上这个评论是由XCode自动生成的,我实际上修改了名称和评论格式headerdoc.没有日期或日期格式.即使我删除这些评论,也没有任何作用; 得到同样的错误.有人可以帮我解决这个问题吗？

Answer 1

我通过更改我的评论格式来修复它:

/**
 *
 */

至

/*!
 *
 */

我的标题评论如下:

/*!
 *  DarkPantherConstants.h
 *  Panther
 *  Created by Midhun on 05/11/14.
 *  Copyright (c) 2014 Midhun. All rights reserved.
 *  Panther Constants are defined in this header file
 */

它解决了这个问题,但我不知道为什么以前的评论格式不起作用.(两者都对headerdoc有效)

Answer 2

执行headerdoc2html时添加-j选项以处理java样式注释(/**)