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
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
  • 10,073
  • 15
  • 85
  • 168
2
votes
2 answers

Integrating Facebook Docset with Xcode

So I downloaded the latest 3.1 Facebook iOS sdk and under the scripts I found a build_documentation.sh which I ran. It completed and generated a com.facebook.Facebook-SDK-3_0-for-iOS.docset file. I am trying to get it to integrate nicely with XCode.…
Endama
  • 743
  • 8
  • 25
2
votes
0 answers

Doxygen / AppleDoc and Jenkins with Objective-C: where should the Doxygen / AppleDoc output live?

Currently our team is using an SVN repository to manage our code on Server A, and changes to this repository trigger builds via Jenkins to be kicked off on Server B (so server B has a workspace that mirrors the repository on Server A). Now, we wish…
KeithComito
  • 1,387
  • 1
  • 13
  • 24
1
vote
2 answers

what is the extension of an executable file in an xcode project

I downloaded apple researchkit last month and run its sample. It worked and every thing was fine. This week i tried to run it , i had build failed and the error is that i need to have appledoc: error: appledoc is required for building ResearchKit's…
Heger
  • 17
  • 6
1
vote
2 answers

Why does CGImageCreateWithImageInRect take a CGRect with points but then use pixels?

Here is the documentation on CGImageCreateWithImageInRect. It takes a CGRect object as a parameter. From what I understand a CGRect is in points However the documentation says: "References the pixels within the resulting rectangle, treating the …
Aggressor
  • 13,323
  • 24
  • 103
  • 182
1
vote
1 answer

How to check appledoc valid or not in the xcode build phases run script?

i'm working in generating docset for a ios project, but stumped. as you known, we can write a sh script for the xcode build phases run script; and i want it run only when the project in release version & the software appledoc already installed, so…
kenmux
  • 151
  • 1
  • 10
1
vote
1 answer

How to document inline protocol using appledoc

I have defined an Objective-C @class that defines a @protocol inline in the header before the @interface. I can't get appledoc to generate the docs for the protocol. Is it possible inline or does the protocol need to be a separate file?
retrodev
  • 2,323
  • 6
  • 24
  • 48
1
vote
1 answer

Macro or dynamic placeholder in appledoc

In my iOS project, I added screenshot images to the documentation of some classes. The documentation is generated with appledoc. Basically, for the class TheViewController, this would look like this: /** * A view controller: awesome and helpful…
Guillaume
  • 21,685
  • 6
  • 63
  • 95
1
vote
1 answer

Adding documentation on GitHub projects with appledoc

I've noticed some projects on GitHub have documentation pages created with Appledoc and hosted at username.github.com/project/Documentation. For example: Project: http://pandamonia.github.com/BlocksKit/ Documentation:…
nathan
  • 1,456
  • 1
  • 15
  • 32
1
vote
1 answer

Appledoc - grouping classes by categories

I'm using Appledoc for generate comments. In basic variants i get page like this http://sdk.quickblox.com/ios/ I want to get something like this http://qblx.co/OrAHzE - classes grouped by categories. I read this doc…
Rubycon
  • 18,156
  • 10
  • 49
  • 70
1
vote
1 answer

Reloading docset without restarting Xcode

I am using appledoc for generating docsets. Everything is good, except everytime I rebuild it(with using my plist and run shell script) I must restart xcode to see changes. Is there a way for force xcode to reload docset ?
Eftal Ersoy
  • 11
  • 2
0
votes
0 answers

APP SUPPOURT IPV6 Api

I am using NsUrl Session throughout whole app. Is their any need for change of API. WILL apple approved my APP.My api http://alatiffy.com/webservice/terms.php
Rishab
  • 31
  • 5
0
votes
1 answer

IOS Developpement : Background BLE Precisions on Apple doc

I everyone, I'm trying to develop two apps that act as a central and a peripheral, which automatically connect to each other when they enter in the bluetooth range while both are in background. I posted something about my issue (because none of my…
Olympiloutre
  • 2,268
  • 3
  • 28
  • 38
0
votes
1 answer

Getting reference error from appledoc when embedding code in comments

I have some code comments like this: /** How to use this method. @discussion To use it, do something like the following id hook = [[STDeallocHook alloc] initWithBlock:^{ // Do something when 'hook' is dealloced }]; */ So the code…
drekka
  • 20,957
  • 14
  • 79
  • 135
0
votes
0 answers

How to except private method from output using "appledoc"?

I am using appledoc to make document of Objective-C(iOS) static library. Document is made for customer and I don't want to document private method. How to prevent documenting private method?
conecon
  • 404
  • 4
  • 10
1
2
3