smallseo.info

appledoc

Objective-c code Apple style documentation set generator. Gentle Bytes - Crafting useful software

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 ?


Source: (StackOverflow)

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. I know that apple docs can create documentation that shows up in the quick help panel. My own custom documentation works great.

Does anyone know what I have to do to get the same kind of documentation integration with Facebook?


EDIT: I tried adding the docset to the corresponding folder according to the instructions here and restarted Xcode but it didn't work


Source: (StackOverflow)

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 to use a document generator like doxygen or appledoc, but I am unsure where the resulting documentation should live.

For example, Jenkins has a doxygen plug in; but since jenkins build commands only have access to the current workspace, this implies that the doxyfile to be accessed by the jenkins plugin must exist in the workspace, and thus be under source control (coming from the repository). This is fine, but the resulting doxygen output should not really be source controlled, so does that mean the doxyfile should specify the output to be created somewhere on server B that is outside the workspace?

Furthermore, the overall goal would be to have docksets generated to be used seamlessly via our individual team member's Xcodes; but this seems like it would imply that the resulting dockets / makefiles etc do indeed need to be somehow part of the workspace (so that the individual team members can receive the results via SVN updates)...but this seems clunky, and I am not even sure if it is kosher to have folders/files created in a workspace that isn't coming from the SVN repository (since the workspace is meant to be a mirror).

Basically I am looking for a way to have documentation/docsets generated via Jenkins as a part of the build process, and for our individual team members to have Xcode option-click goodness to that resulting documentation (ideally without any manual steps required). Is this possible?

Thank you.


Source: (StackOverflow)

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...

enter image description here

An simple example how this would look in code is:

/** Loads a project from web service.
 @param securityKey The security key.
 @param block The block to execute after the web service returned all data. The block takes five arguments:
     @param data The data.
     @param fields Some fields.
*/
- (void)loadProjectWithSecurityKey:(NSString *)securityKey andCompletion:(void(^)(NSDictionary *data, NSDictionary *fields))completion;

But clearly this will only appear like this in the documentation:

enter image description here

How do I get data and fields to appear indented like Apple's method that takes a block with arguments?

I couldn't find how to do this in Apple's documentation on HeaderDoc


Source: (StackOverflow)

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 class description.
 *
 * **iPhone Screenshot:**
 * ![](../docs/documentation_data/ViewControllersScreenshotsGallery/screenshots/TheViewController_iPhone.png)
 *
 * **iPad Screenshot:**
 * ![](../docs/documentation_data/ViewControllersScreenshotsGallery/screenshots/TheViewController_iPad.png)
 */


Is there any way to DRY this?
A macro, pre-processing (via preprocess-headerdoc?), dynamic placeholder, script, options fed to appledoc?

Ideally, I would like to just have this:

/**
 * A view controller: awesome and helpful class description.
 *
 * SCREENSHOTS_FOR_IPAD_AND_IPHONE
 */




Bonus point if I don't even have to add the line SCREENSHOTS_FOR_IPAD_AND_IPHONE, and the content is only added if some condition is met (ie, if images are found where expected).


Source: (StackOverflow)

appledoc bug - properties listed in "other methods"

I am hitting an issue with AppleDocs and was hoping that you guys could help me out.

I have a property in my code defined as follows:

@property (nonatomic, readonly) NSURL *identifier LYR_QUERYABLE_PROPERTY;

Unfortunately, AppleDocs is documenting the code incorrectly, as it is effectively removing the "identifier" property name and displaying it as:

@property (nonatomic, readonly) NSSet *LYR_QUERYABLE_PROPERTY

In addition, my documentation that's generated also lists my properties under "Other Methods:". If anyone can shed any light on these issues, it would be much appreciated!

Cheers!


Source: (StackOverflow)

Inhibiting appledoc warnings

In some of my headers there are a few constants defined which describe different, self-explanatory, states. So I don't want to add a block comment to each of these constants. How can I silence those warnings?


Source: (StackOverflow)

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 http://gentlebytes.com/appledoc-docs-comments/ , by not found any information about this. Anybody did something like this? tanks


Source: (StackOverflow)

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 generate my project doc I get theses troublesome warnings :

/Users/Me/trunk/MyProject/MyProject/src/MyClass.m:119: MyClass.m@119: Description for parameter 'myParam' missing for -[MyClass myMethod:]

Obviously I could get rid of my TODO comments but I'd like to keep them along with my beautyful doc. Does anybody know how to achieve that ?


Source: (StackOverflow)

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: http://pandamonia.github.com/BlocksKit/Documentation/

How does this work? Is there a way I could do this for my own project?


Source: (StackOverflow)

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 round item */
    kMenuItemNewRound,
    /** The archive item */
    kMenuItemArchive,
    /** The participants item */
    kMenuItemMyParticipants,
    /** The locations item */
    kMenuItemMyLocations,
    /** The settings */
    kMenuItemSettings,
    /** The contact page */
    kMenuItemContact,
    /** The count */
    kMenuItemTotal
};

/**
 * This is the Menu View Controller.
 *
 * The menu view controller handles the menu the menu and its options. You can access the menu view controller using the `menuContainer` in the `ApplicationDelegate`
 *
 */
@interface MenuTVC : UITableViewController


@end

My run script build phase:

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
echo "Generating docs!";
$APPLEDOC_PATH \
--project-name "${PRODUCT_NAME}" \
--project-company "Sogeti Sverige AB" \
--company-id "se.domain.project" \
--output "Docs" \
--no-install-docset \
--exit-threshold "2" \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--ignore "Pods" \
--ignore ".m" \
--index-desc "${PROJECT_DIR}/Readme.md" \
${PROJECT_DIR}/Prevent
else
echo "AppleDoc not found or installed!"
fi;

The result: google chromescreensnapz007

And build result:
xcodescreensnapz011

From the terminal:

$ which appledoc
/usr/bin/appledoc
$ appledoc --version
appledoc version: 2.2 (build 963)

I just can't seem to figure it out.

Thanks in advance!


Source: (StackOverflow)

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 i write it as follows:

# appledoc Xcode script
APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
if [ "${CONFIGURATION}" = "Release" ]; then
#============================#
#   some code here, omit!    #
#============================#
fi
fi

it seems not work at all! and i know the problem is the command 'which appledoc' went wrong! so the question is:

how to check appledoc valid or not in the xcode build phases run script?
any ideas? please give a hand! thanks!

Source: (StackOverflow)

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), but the script is not executed (no output in the console). The script has been already tested in the terminal and it works fine! and I also created a dummy script with a simple echo and the result is the same... why? How can I debug this?

enter image description here

EDIT:

After solving the problem I realized what I had in mind, if you are interested read my post: Generate beautiful code documentation with a simple shortcut using AppleDoc, Xcode custom behaviors and AppleScript!


Source: (StackOverflow)

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 genetate document, its creating the references for demo classes also. I dont want this. I'm expecting appledoc to generate documentation for my reusable class only. How could I do that?

My runscript is like this:

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \
--project-name "MyControl" \
--project-company "Company Name" \
--company-id "" \
--output ${PRODUCT_NAME}Docs \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--ignore "*.m,AppDelegate.h,ViewController.h" \
--exit-threshold 2 \
${PROJECT_DIR}/${PRODUCT_NAME}
fi;

Tried adding my AppDelegate and ViewController class in --ignore tag, but it doesn't seems working. Is there anything I'm missing here?


Source: (StackOverflow)

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 to see custom text i typed to describe what an asset really is. Additionally type of the ivar would also be useful to know.

How can this be done? In this case, i wonder what exactly did i mean by assets

I specifically wonder if this information can be viewed from inside Xcode, similar to how Eclipse shows JavaDoc content.

enter image description here


Source: (StackOverflow)