HeaderDoc 不生成 HTML 文档 [英] HeaderDoc not generating HTML Documentation

问题描述

我正在为 iOS 应用开发可重复使用的 API 组件.我已经完成了 API 并使用 headerdoc 为未来的用户记录了下来.

I'm working on a re-usable API component for iOS apps. I have completed the API and documented it using headerdoc for future users.

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

Now I want to create HTML pages for those header files. So I executed the following command in terminal from my project directory

headerdoc2html -o ~/Desktop/My_Project_Documentation APIFolder/

但是没有创建文档，而是出现如下错误:

But No documents are being created, instead I'm getting an error like:

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

我尝试了各种方法和方式，终于缩小了问题的范围:

I tried various methods and ways, finally I narrow down the issue:

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

In the beginning of my project I have something like:

/**
 *  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.没有日期或日期格式.即使我删除了这些评论，也无济于事；得到同样的错误.有人可以帮我解决这个问题吗?

So the issue was with this particular comment, actually this comment is auto-generated by XCode and I actually modified the name and comment format to headerdoc. Nothing with date or date-format. Even If I remove those comments, nothing works; getting same error. Can anybody please help me to solve this ?

推荐答案

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

I fixed it by changing my commenting format from:

/**
 *
 */

到

/*!
 *
 */

我的标题评论如下:

/*!
 *  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 有效)

And it solved the issue, but I don't know why the previous commenting format not working. (Both are valid for headerdoc)

这篇关于HeaderDoc 不生成 HTML 文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！