I'm using headerdoc extensively in all projects and within Xcode it works just fine. As in option-clicking a variable or method correctly shows the documentation as expected.
The problem is I also export the documentation to html using headerdoc2html. For some reason headerdoc2html doesn't understand how to deal with '@Property'. So at the top of each html file I have a section titles Functions. It looks like this:
Not only that but headerdoc2html is spitting out a bunch of duplicate declaration errors as well
I have tried various different form of annotating the @Property declarations without any luck.
I can't seem to find a way of getting this to work properly. Haven't found this problem discussed anywhere else either and all tutorials setting up headerdoc2html conveniently omits the use of @properties in their examples.
I have read that Doxygen seem to be able to deal with objc properties but I'm a bit reluctant to go with Docygen as it seems to be a good bit of setting up and configuring required and the resulting html just doesn't look that good. I know that can be styled but I'm pretty happy with the headerdoc2html styling.
The problem is I also export the documentation to html using headerdoc2html. For some reason headerdoc2html doesn't understand how to deal with '@Property'. So at the top of each html file I have a section titles Functions. It looks like this:
Code:
Functions
------------------------------------------------------------------
property(nonatomic, readonly)
The breif about myBool goes here
property(nonatomic, readonly)
The breif about myInt goes here
property(strong, nonatomic, readonly)
The breif about myString goes here
------------------------------------------------------------------
property(nonatomic, readonly)
The breif about myBool goes here
@property (
nonatomic,
readonly) BOOL myBool;
------------------------------------------------------------------
property(nonatomic, readonly)
The breif about myInt goes here
@property (
nonatomic,
readonly) NSInteger myInt;
------------------------------------------------------------------
property(strong, nonatomic, readonly)
The breif about myString goes here
@property (
strong,
nonatomic,
readonly) NSString *myString;
------------------------------------------------------------------
Not only that but headerdoc2html is spitting out a bunch of duplicate declaration errors as well
Code:
Conflicting declarations for function/method (property) outside a
class (apioclass=HeaderDoc::Header). This is probably not what
you want. This warning is usually caused by failing to include a
HeaderDoc comment for the enclosing class or by using the wrong name
with an old-style HeaderDoc tag such as @function.
I have tried various different form of annotating the @Property declarations without any luck.
I can't seem to find a way of getting this to work properly. Haven't found this problem discussed anywhere else either and all tutorials setting up headerdoc2html conveniently omits the use of @properties in their examples.
I have read that Doxygen seem to be able to deal with objc properties but I'm a bit reluctant to go with Docygen as it seems to be a good bit of setting up and configuring required and the resulting html just doesn't look that good. I know that can be styled but I'm pretty happy with the headerdoc2html styling.