Questions tagged [appledoc]

appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments.

It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those know to me fall short in meeting the minimum of goals described below.

Main goals of appledoc:

Human-readable source code comments.
Simple cross references to objects and members.
Generate Apple-like source code HTML documentation.
Generate and install fully indexed and browsable Xcode documentation set.
Single tool to drive generation from source code parsing to documentation set installation.
Easily customizable output.
100% Objective-C implementation for easy debugging.

https://github.com/tomaz/appledoc#readme

41 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
9
votes
3 answers

how to use appledoc to generate an Apple-like documentations

I am reading on the article how to generate an Apple-like HTML documentation at here. My questions are what the command lines are used for. How can we combine command lines and appledoc xcode project to generate a HTML.
tranvutuan
  • 5,995
  • 8
  • 44
  • 82
7
votes
2 answers

How to create documentation for instance variable and methods in Xcode?

I'd like to be able to Alt-Click an instance variable (or a method) as part of the program i created and read what it's purpose is. The fact that Xcode is telling me the class variable is declared at - is nice but not enough. In this case i'd like…
James Raitsev
  • 82,013
  • 132
  • 311
  • 454
7
votes
1 answer

Objective-C and Swift Documentation together like Apple documentation

I am currently working on building iOS SDK, written in Objective-C. Now that I have SDK tested and ready, would wanted to add Documentation to it combining Swift and Objective-C. I have worked on following Doc generator tools a. Doxygen b.…
Ram
  • 81
  • 4
7
votes
2 answers

Appledoc inline code in Xcode Quick Help panel?

How can I indicate inline code blocks like this in Appledoc comments? Backticks just read as backticks in Xcode Quick Help panel. I'd really love to have NSStringFromClass codified somehow.
Geri Borbás
  • 13,770
  • 13
  • 97
  • 158
3
votes
0 answers

appledoc- runscript- Expected end of line but found identifier

I'm trying to run this script as part of generating documentation using appledoc plug in. But, I'm receiving this 'Expected end of line but found identifier.' error when I run this script in Xcode(or terminal). Please help me out as I'm new…
rak appdev
  • 657
  • 7
  • 20
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
0 answers

Appledoc crashes on every use

I hope this isn't a duplicate but after browsing the other issues I think its ok bring up the several issues I have been having with the Appledoc 2.2-963. I installed using brew which worked great, and apple doc has been generating me awesome…
m33k
  • 173
  • 5
3
votes
2 answers

Use appledoc to generate documentation for some particular classes

I have written a simple reusable control and on looking for a way to document its functions and properties, I found this useful tool named - appledoc. I have created a demo project to show the capabilities of my control. Now when I use appledoc to…
HRM
  • 2,059
  • 6
  • 20
  • 37
3
votes
0 answers

Is there any way to generate documentation using appledoc in AppCode?

Or is there any way (using other docs generators) to make it work in AppCode ?
AndrewShmig
  • 4,425
  • 5
  • 35
  • 64
2
votes
2 answers

appledoc Exception: at least one directory

After wasting some time to figure out what goes wrong, I finally have to ask for help. I want to use appledocs from Gentle Bytes. I followed every step of the quick install guide, but I´m not able to compile the project. Here is what I´ve done: 1.…
Tomte
  • 1,237
  • 12
  • 18
2
votes
1 answer

Xcode 4: custom behavior does not execute my sh script?

I created a custom behavior in Xcode 4 (Xcode > behaviors > edit behaviors > +) in order to launch a shell script (which is configured to be executable). I can invoke the behavior using the menu or my custom shortcut (console shows up as specified),…
daveoncode
  • 16,281
  • 13
  • 90
  • 146
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…
2
votes
0 answers

Quick Help in Xcode - How to create links between classes in the same project

In a class, I have the following method and comment: /** A list of GSDContentLayer objects comprising the layers for the current drawing. @see GSDContentLayer for an explanation on drawing layers. */ -(NSArray *)layers; This comment can be seen…
Izhido
  • 353
  • 3
  • 10
2
votes
2 answers

Not getting appledoc to document NS_ENUM

could someone please explain what I am doing wrong when documenting my typedef NS_ENUM? This is my syntax: /** The different menu items */ typedef NS_ENUM(NSInteger, kMenuItem) { /** The start page */ kMenuItemStartPage = 0, /** The new…
Paul Peelen
  • 9,588
  • 15
  • 82
  • 162
1
2 3