HeaderDoc не генерирует документацию HTML

Question

Я работаю над повторно используемым компонентом API для приложений iOS. Я выполнил 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

Добавьте опции -j при выполнении headerdoc2html, чтобы также обрабатывать комментарии в стиле Java ( /**)