HeaderDoc does not generate HTML documentation
I am working on a reusable API component for iOS apps. I completed the API and documented it with help headerdoc
for future users.
Now I want to create HTML pages for these header files. So I ran the following command in terminal from the project directory
headerdoc2html -o ~/Desktop/My_Project_Documentation APIFolder/
But no documents are generated, instead I get 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 have tried various methods and ways, in the end I narrow down the problem:
At 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
*/
So the problem was with this particular comment, in fact this comment is autogenerated by Xcode and I actually changed the format of the name and comment to headerdoc
. Nothing with date or date. Even if I remove these comments, nothing will work; getting the same error. Can anyone help me solve this problem?
source to share
I fixed it by changing the format of the comments:
/**
*
*/
to
/*!
*
*/
I made my title 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
*/
And it solved the problem, but I don't know why the previous comment format doesn't work. (Both values are valid for headerdoc)
source to share