Stack Overflow
Stack Overflow

Questions tagged [headerdoc]

HeaderDoc is documentation generator developed and maintained by Apple Inc.

HeaderDoc is documentation generator developed and maintained by Apple Inc. Using specially commented source code files as input, HeaderDoc generates documentation for the code in HTML or XML format. Syntax for HeaderDoc comment tags is largely similar to, and as of HeaderDoc version 8, supportive of Javadoc tags. HeaderDoc 8.7 and later also provides partial support for many Doxygen tags (@ form only, and must conform to HeaderDoc tag ordering rules). Apple's HeaderDoc project is free, open source software distributed under the Apple Public Source License.

25 questions
1
vote
1 answer

Using HeaderDoc with .hpp files instead of .h files

I want to document my interface. The interface is written in C++ and it is in .hpp files. However, headerdoc2html doesn't seem to know about .hpp files; it expects .h files. $ headerdoc2html include/*.hpp HTML output mode. File…
user142019
1
vote
2 answers

See my own HeaderDoc in Xcode

I write a lot of C#, and in Visual Studio I can see my own documentation when autocomplete appears to describe the function and its parameters. Is this same functionality available in Xcode using my HeaderDoc descriptions? If it helps the relevance…
Nippysaurus
  • 20,110
  • 21
  • 77
  • 129
1
vote
0 answers

Objective-C - document header and not code file?

I would like to start documenting my code properly, but am unsure where the best place is to put it for HeaderDoc to read. I read the following phrase in the HeaderDoc documentation which makes me think the intended location (from Apple's point of…
Nippysaurus
  • 20,110
  • 21
  • 77
  • 129
1
vote
0 answers

How to hide certain Objective-C method header documentation (HeaderDoc) comments

Is there a way in Objective-C documentation (HeaderDoc) to hide certain comments from being visible to the public? In other words, when you option-click (alt-click) on a method you're calling, that box pops up showing the comments for that…
Ethan G
  • 1,353
  • 2
  • 15
  • 31
1
vote
1 answer

Script for automatically generate the html output from headerdoc comments from within Xcode

I'm using headerDocs to document my Xcode Project. And I successfully documented my project. but I want to know the script for automatically generate the html output from headerdoc comments from within Xcode. To the info I know to run the headerdoc…
Deepakraj Murugesan
  • 1,195
  • 11
  • 30
1
vote
0 answers

Headerdoc, Objective-C, anonymous type, ERROR

I have to generate a doc for Xcode's project Objective-C. I have an error anonymous type. I think headerdoc doesn't like @interface section. Can someone resolve that? My apologies for some grammar mistakes, I have a Xcode's project Objective-C, I…
Minh Huy
  • 45
  • 1
  • 5
1
vote
2 answers

HeaderDoc not generating HTML Documentation

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. Now I want to create HTML pages for those header files. So I executed the following command in terminal from my…
Midhun MP
  • 103,496
  • 31
  • 153
  • 200
1
vote
1 answer

How to add multiline comment in HeaderDoc

This is my code /** * In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images */ @interface WOC_OnOffImageButton : SKSpriteNode And when I do alt-click on WOC_OnOffImageButton in popup inside…
WebOrCode
  • 6,852
  • 9
  • 43
  • 70
0
votes
1 answer

Headerdoc generate without body tag

We are using headerdoc to create html files for our documentation which will be rendered as a partials in our web framework. We would like to know if there is a way to prevent head, html, and body tags from the html files that header doc generates…
MobileOverlord
  • 4,580
  • 3
  • 22
  • 30
0
votes
1 answer

How to document NSNotifications properly with headerdoc?

The documentation for UIApplication contains a section Notification where all related NSNotifications are listed. Unfortunately, the header files available in Xcode don't contain the corresponding comments. The HeaderDoc User Guide shows how the…
Etan
  • 17,014
  • 17
  • 89
  • 148
1
2