StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

POHow to make Xcode display comments below user-defined methods?
text
Body
copied!<p>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.</p> <p>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?</p> <p>Thank you!!!</p> <hr> <p>@HAS:</p> <p>I follow your instruction till Step 12, and create a simple test class in .h file as:</p> <pre><code>#import <Foundation/Foundation.h> @interface AMCAppleDocTest : NSObject @property (nonatomic, retain) NSString *version; + (id) test; /** @name Section title */ /** Method description */ - (void)doSomething; @end </code></pre> <p>Then to Step 13, I run the script, but error occurred as picture below:</p> <p><a href="http://oi43.tinypic.com/686lqd.jpg" rel="nofollow noreferrer">http://oi43.tinypic.com/686lqd.jpg</a></p> <p>My .sh script:</p> <pre><code>#! /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" </code></pre> <p>And the .command file:</p> <pre><code>#!/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 </code></pre> <p>And besides, my Xcode version is 4.5.1 and OS X 10.8.</p> <p>Xcode is not installed into /Applications folder but simply put at desktop. Does it matter?</p> <hr> <p>@ HAS, again</p> <p>I found what went wrong: the script was in dos format. I solved that in VI using <i>:set ff=unix</i>. Now every things goes perfectlly:</p> <p><a href="http://oi43.tinypic.com/2uj58yb.jpg" rel="nofollow noreferrer">http://oi43.tinypic.com/2uj58yb.jpg</a></p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload