HeaderDoc不产生HTML文档(HeaderDoc not generating HTML D

2019-10-21 11:20发布

我正在为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风格的注释(/ **)



文章来源: HeaderDoc not generating HTML Documentation