How to make Xcode display comments below user-defined methods?

Question

If we type a method from Apple API, Xcode will display method functions below the auto-complete pop-up list. But typing a user-defined method, it shows nothing.

Is there a way to tell Xcode to display some descriptions that I defined by myself to show how to use the user-defined methods?

Thank you!!!

@HAS:

I follow your instruction till Step 12, and create a simple test class in .h file as:

#import <Foundation/Foundation.h>

@interface AMCAppleDocTest : NSObject
@property (nonatomic, retain) NSString *version;
+ (id) test;
/** @name Section title */
/** Method description */
- (void)doSomething;
@end

Then to Step 13, I run the script, but error occurred as picture below:

My .sh script:

#! /bin/sh
docsURL="http://www.AMC.com";
projectsPath="$2/../";
docsPath="/Users/AMC/Library/Developer/Documentations/$1";

# create AppleDocOutput folder if not exists
if [ ! -d $docsPath ];
then
mkdir "${docsPath}";
fi

/Users/AMC/Library/Developer/DocumentationStuff/appledoc \
--project-name "$1" \
--project-company "AMC" \
--company-id "com.AMC" \
--docset-atom-filename "$1.atom" \
--docset-feed-url "${docsURL}/%DOCSETATOMFILENAME" \
--output "/Users/AMC/Library/Developer/Documentations/$1" \
--docset-package-url "${docsURL}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${docsURL}/$1Doc/" \
--publish-docset \
--logformat xcode \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--ignore "*.m" \
--ignore "LoadableCategory.h" \
--index-desc "$2/readme.markdown" \
"$2" > "${docsPath}/AppleDoc.log"

And the .command file:

#!/usr/bin/osascript

tell application "Xcode"
    tell first project
        -- variables to export
        set projectName to (get name)
        set projectDir to (get project directory)
        set company to (get organization name)
        -- invoke script passing extracted variables
        do shell script ("sh /Users/AMC/Library/Developer/DocumentationStuff/appledoc.generate.sh " & projectName & " " & projectDir & " " & company)
    end tell
end tell

And besides, my Xcode version is 4.5.1 and OS X 10.8.

Xcode is not installed into /Applications folder but simply put at desktop. Does it matter?

@ HAS, again

I found what went wrong: the script was in dos format. I solved that in VI using :set ff=unix. Now every things goes perfectlly:

May be this link will help you :) [1]: stackoverflow.com/questions/10530695/… — Mahesh
– Mahesh, Commented Apr 25, 2013 at 6:37
Sorry for the long delay but I just saw your edit now, I don't get any message unless you post a comment ... Are you sure you made the script executable (step 6)? — HAS
– HAS, Commented Apr 27, 2013 at 20:04
Oh, I solve that. Thaaaaaaaaank you veeeeeeeeery much !!!!!! Now everything goes smoothly. I updated that in my post. — Andrew Chang
– Andrew Chang, Commented Apr 28, 2013 at 1:40
:) That's nice! :) Thanks for the method description! :) I like that :) — HAS
– HAS, Commented Apr 28, 2013 at 9:15

HAS · Accepted Answer · 2013-12-03 22:13:40Z

1

In my old answer I suggested appledoc (which is fantastic btw) but for what you want it is much easier with Xcode 5 to use its built-in documentation feature (for the old answer take a look at the edit history).

Let's say you have a method like:

- (NSString *)fooBar:(NSNumber *)foo bar:(NSArray *)bar {
    return @"FooBar!";
}

All you have to add is

/**
 *  This is a demo method
 *
 *  @param foo An NSNumber.
 *  @param bar An NSArray.
 *
 *  @return Returns the NSString "FooBar!"
 */
- (NSString *)fooBar:(NSNumber *)foo bar:(NSArray *)bar {
    return @"FooBar!";
}

When typing the method you can see the info at the bottom of the popover

Info with code completion

If you alt-click the method you get all the information:

Method documentation by alt-clicking

If you are lazy (like me) take a look at the wonderful plugin called VVDocumenter. All you have to do using the plugin is typing /// above a method and it automagically generates the documentation structure for you.

Just download, compile, copy and start documenting! Thanks to onevcat for providing such an awesome tool!

edited Dec 3, 2013 at 22:13

answered Apr 25, 2013 at 7:40

HAS

20k6 gold badges34 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

11 Comments

HAS Over a year ago

I am just editing this question to make it a little tutorial ;) If you encounter any problems let me know! Could take a little while to finish it because I am having lecture right now but I'll do my best to make the edit asap!

Andrew Chang Over a year ago

I have read the introduction briefly and understandood that it may take a while, too. Actually, as it seemes not to be an easy job enough, I will do that later. But still, thank you very much!

HAS Over a year ago

@AndrewChang I've edited my post, if you have any question let me know! :)

Andrew Chang Over a year ago

Wow!!! So detailed!!! Thanks a looooooooooot!! You make me want to try appledoc right NOW!!! I will try that now!

HAS Over a year ago

Yeah, I hope it's detailed enough. When I installed and configured it I spent hours with it. So I hope that it helps saving someone (at least you) some time ;)

|

Collectives™ on Stack Overflow

How to make Xcode display comments below user-defined methods?

1 Answer 1

11 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

11 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related