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)

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. In App Purchases Guide Table 12-5 from Apple Developer Docs.

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 find it?

Here is the screen shot of what I see in my iTunesConnect enter image description here


Source: (StackOverflow)

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. Hope someone could help me with the problem.


Source: (StackOverflow)

Appledoc reference to input parameter class

Apple documentation has cross reference for input parameters. You can see that NSStringEncoding and NSError are highlighted: enter image description here

But when I use appledoc, there are no cross reference at all: enter image description here

This is my config file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>--company-id</key>
    <string>com.vk</string>
    <key>--create-docset</key>
    <false/>
    <key>--create-html</key>
    <true/>
    <key>--ignore</key>
    <array>
        <string>ThirdParty</string>
        <string>Libraries</string>
        <string>Frameworks</string>
        <string>Testing</string>
    </array>
    <key>--install-docset</key>
    <false/>
    <key>--docset-platform-family</key>
    <string>iphoneos</string>
    <key>--output</key>
    <string>docs</string>
    <key>--project-company</key>
    <string>VK.com</string>
    <key>--project-name</key>
    <string>VK iOS SDK</string>
    <key>--keep-undocumented-objects</key>
    <true/>
    <key>--keep-undocumented-members</key>
    <true/>
    <key>--warn-undocumented-object</key>
    <false/>
    <key>--warn-undocumented-member</key>
    <false/>
    <key>--warn-empty-description</key>
    <true/>
    <key>--warn-missing-arg</key>
    <true/>
    <key>--warn-unknown-directive</key>
    <true/>
    <key>--logformat</key>
    <string>xcode</string>
    <key>--exit-threshold</key>
    <integer>2</integer>
</dict>
</plist>

What's wrong?


Source: (StackOverflow)

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 documentation. See http://appledoc.gentlebytes.com

I did some research and i found this page

 [1]: https://github.com/tomaz/appledoc#quick-install

I downloaded the project and built it and i found my

build directory.

But, i didn't know what is the executable file in this directory and how can i add it to the path. Can someone help me ? thanks a lot.


Source: (StackOverflow)

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 /SourceCache/IDEPlugins/IDEPlugins-5064/IDEQuickHelp/Models/IDEQuickHelpContentCreator.m:321
Details:  Error creating XML document from clang-parsed comment block: Error Domain=NSXMLParserErrorDomain Code=73 "Line 1: invalid character in attribute value
Line 1: attributes construct error
Line 1: Couldn't find end of Start Tag Function
" UserInfo=0x7fc78fb98500 {NSLocalizedDescription=Line 1: invalid character in attribute value
Line 1: attributes construct error
Line 1: Couldn't find end of Start Tag Function
}

Could anyone help me please?

Sorry for my bad english


Source: (StackOverflow)

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 example is indented with 4 spaces. When I compile the docset with appledoc, it compiles correctly and shows the code as code in the API reference I generate. However back in XCode (Where I have appledoc creating warnings for issues in the doco) I get the warning:

Invalid [[STDeallocHook alloc] reference found hear STDeallocHook.h@16, unknown object: [STDeallocHook !

I think what's happening is that appledoc is looking for markdown links inside the code block.

How can I stop this warning from appearing?


Source: (StackOverflow)

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} == "Release" ]; then
APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \
--project-name ${PRODUCT_NAME} \
--project-company "Your Name" \
--company-id "com.yourcompany" \
--output ${PRODUCT_NAME}Docs \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
${PROJECT_DIR}/${PRODUCT_NAME}
fi;
#fi; 

To make sure I install the appledoc correctly, I did the following from the terminal and the doc shows up fine.

appledoc --project-name BabelCPP --project-company "My Name" --company-id com.mycompany --no-create-docset --output ./doc/ ./CaterpillarCount/CaterpillarCount

Am I missing any critical step or setup in Xcode? It seems like the following part didn't execute correctly and it's what terminate this run script:

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \

Source: (StackOverflow)