Stack Overflow
Stack Overflow

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
0
votes
1 answer

Appledoc can't run in Xcode

So I'm following this tutorial for the appledoc generation (http://objcsharp.wordpress.com/2013/09/24/how-to-generate-beautiful-apple-style-documentation-in-xcode-5/). Nothing happens after the build. Here's the script: #if [ ${CONFIGURATION} ==…
Yinan Fang
  • 265
  • 4
  • 11
0
votes
1 answer

generating documentation with companion guides using appledocs?

we are working on several internal projects. We would like to keep all documentation in the same place. We are using appledocs for the code documentation. But we need some pages (like apple have their companion guides) that we would like to bundle…
Erik
  • 5,791
  • 5
  • 30
  • 45
0
votes
1 answer

Using appleDoc and ///TODO: comment

I'm working on a project that uses AppleDoc to generate documentation. I want to add some TODO comments in my code eg: ///TODO: Some stuff to be done -(void)myMethod:(id)myParam{ [self doSomeFancyStuff]; } The problem is that when I try to…
AnderCover
  • 2,488
  • 3
  • 23
  • 42
0
votes
2 answers

Xcode 5 Documentation Error

I wanted to describe my code like this /** Loads and parses the XML file*/ +(NSMutableArray *)loadXML:(NSString *)table; But when I try to use the quick help for loadXML: Xcode crashes with this Error: ASSERTION FAILURE in…
BigStorm
  • 30
  • 7
0
votes
1 answer

startMonitoringSignificantLocationChanges issue

Im using -startMonitoringSignificantLocationChanges in my application. Application when in background - (void) locationManager:(CLLocationManager *)manager didUpdateToLocation:(CLLocation *)newLocation fromLocation:(CLLocation *)oldLocation method…
mychar
  • 1,031
  • 1
  • 11
  • 20
0
votes
1 answer

Why are Appledoc references to input parameter classes not being highlighted?

Apple documentation has cross reference for input parameters. You can see that NSStringEncoding and NSError are highlighted: But when I use appledoc, there are no cross reference at all: This is my config file:
Roman Truba
  • 4,401
  • 3
  • 35
  • 60
0
votes
1 answer

Appledoc Exception: At least one directory or file name path is required

Cho-Yeung-Lam:gogopiao_v2 apple$ appledoc -o ./doc --project-name gogopiao_v2 as I type the command above, error occur: At least one directory or file name path is required, use 'appledoc --help' gogopiao_v2 is the root directory of my project.…
JackieLam
  • 668
  • 1
  • 7
  • 20
0
votes
1 answer

AppleDoc Categories not showing in quickhelp

I've succesfully generated a docset with AppleDoc by following the installation instructions. If i got into XCode Documentation Organiser, everything is there, including the categories: But when I ⌥-click on one of my category methods I see nothing…
Rob van der Veer
  • 1,148
  • 1
  • 7
  • 20
0
votes
2 answers

AutoRenewable subscription in app purchases didn't have free trial

As per In App Purchases Guide in apple's developer resources, it clearly says that we can offer free trial option. But I couldn't able to see it anywhere when I am setting in App purchases in iTunesConnect. Are they still offering that? Where can I…
Murali Patteboyina
  • 387
  • 6
  • 17
0
votes
2 answers

Appledoc and custom link description

If I'm doing something stupid, I'm sorry in advance. But I cannot identify my error. Here is the code (header file): #import /** Represents a cover image. It can be a game cover, a trophy image or even a player avatar. …
backslash-f
  • 7,923
  • 7
  • 52
  • 80
0
votes
2 answers

Appledoc automatically copy html to project directory

So I have a build script which runs after building my library in xcode which generates the appledoc documentation and installs it into XCode. Annoyingly this puts all the HTML etc into an obscure folder in the (hidden) Library folder in my user home…
Thomas Clayson
  • 29,657
  • 26
  • 147
  • 224
1 2
3