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
74
votes
3 answers

Objective-C Documentation Generators: HeaderDoc vs. Doxygen vs. AppleDoc

I need to implement a documentation generation solution for my workplace and have narrowed it down to the three mentioned in the title. I have been able to find very little information in the way of formalized comparisons between these solutions,…
KeithComito
  • 1,389
  • 1
  • 13
  • 24
11
votes
1 answer

How to generate HTML documentation for SWIFT files in Xcode with HeaderDoc?

I tried to document my Swift project in Xcode with HeaderDoc, but are processed only files ".h" and are ignored files ".swift" This is my swift File: /// test /// /// :param: ann blabla func testFunc( ann: Foo ) { .. } I run the following in the…
ottorottok
  • 171
  • 3
  • 11
10
votes
1 answer

Documenting code in Xcode 8

I have seen that Apple's HeaderDoc User Guide has been marked as "Retired Document" with this note: Important: This document may not represent best practices for current development. Links to downloads and other resources may no longer be…
AppsDev
  • 11,441
  • 20
  • 81
  • 163
7
votes
5 answers

How to mark code snippet in Headerdoc?

I usually need to write many short code in code comment like this. Is this possible to use in Apple's Headerdoc? Because this type of code notation is generally used heavily, so i believe there's a convenient way to do this instead of marking HTML…
eonil
  • 75,400
  • 74
  • 294
  • 482
5
votes
0 answers

Using @link with Xcode 6

I'm using HeaderDoc to document my code and I would like to link to other methods in the documentation. I'm not trying to generate HTML (at least for now) but I do want it to appear in Xcode's right panel. The following is the documentation for…
André Fratelli
  • 5,494
  • 4
  • 37
  • 80
5
votes
0 answers

headerDoc error in Objective-c .m files

I'm using headerDoc tags in XCode and can't seem to document private methods in .m files. Using sample syntax straight from Apple's site: @implementation AppDelegate /*! This is an objective-C method. @param application Parameter A. @param…
Brendenw
  • 683
  • 1
  • 5
  • 21
4
votes
0 answers

Add a link to another method in the @see section of headerdoc

I'm trying to add a link to a UIKit method in my own documentation. According to this documentation, I should add a @see tag with an //apple_ref/ link. Here's my documentation : /** * Creates and add constraints to the receiver * * @return The…
DCMaxxx
  • 2,444
  • 2
  • 22
  • 44
4
votes
3 answers

Generate Apple Docs for XCODE project

I am trying to generate apple docs for one of my projects. I am using the following commands to generate the docs... headerdoc2html -o OutPutDirectory InputDirectory I am getting the following message... Processing…
Ankit Srivastava
  • 11,975
  • 9
  • 57
  • 111
3
votes
1 answer

What's the benefit of using @discussion in comments?

I'm seeing @discussion in some sample codes. My question is, what's the benefit of using this keyword? I suppose it will generate better documentation. I tried to search on Google and Stackoverflow, but got a lot of code samples instead of how to…
lichen19853
  • 1,230
  • 2
  • 12
  • 21
3
votes
1 answer

How to indent documentation in appledoc/HeaderDoc (for documentation on blocks that take arguements)

I created a method that has a block as a parameter. The block takes some arguments, so I would like to indent the documentation like Apple does in their methods that have a similar format... An simple example how this would look in code is: /**…
timgcarlson
  • 2,848
  • 23
  • 49
3
votes
2 answers

Xcode documentation comment syntax

I was wondering if someone could explain what/if there is any difference between the following two comment syntax in Xcode. /** * comments */ /*! * comments */ It seems like both allow Xcode to display your comments as documentation but I'm…
strikerdude10
  • 565
  • 5
  • 11
3
votes
1 answer

automatically insert header doc comments in Objective C?

Since XCode 5 now supports reading header comments directly from header files, it has become increasingly interesting, to document functionality in a consistent way. I therefore try to find a tool that can automatically insert header doc comments…
EsbenB
  • 3,306
  • 19
  • 40
2
votes
1 answer

Does Doxygen/headerdoc supports swift 4.0?

We are currently planning to create the documents using comments. So any one have any idea how to achieve that. As i have checked most of the post that Doxygen/headerdoc don't support Swift.
Kapil_A
  • 95
  • 1
  • 13
2
votes
2 answers

How do I escape a Swift doc comment Callout?

I have the following doc comment in Swift: /** - Trace - ↓ - Debug - ↓ - Information - ↓ - Warning - ↓ - Error */ The line that says "Warning" does not render in Xcode because "- warning" is a keyword callout in swift doc…
S Coder
  • 31
  • 4
2
votes
1 answer

Headerdoc with delegate Protocols - Swift and xcode 7.2

I have defined a protocol and added HeaderDoc documentation to the method in this protocol. It appears correctly when I Option+Click the method: However, when I Option+Click the implementation within a controller that implements this protocol, the…
Victor Tavares
  • 130
  • 5
1
2