Is there a Javadoc-like plugin for Xcode that automatically generates the doc template?

Posted by Mark on Stack Overflow See other posts from Stack Overflow or by Mark
Published on 2010-03-19T09:35:51Z Indexed on 2010/03/19 9:41 UTC
Read the original article Hit count: 168

Filed under:

objective-c

|

xcode

|

documentation-generation

I'm aware of Doxygen to generate the documentation. What I'm looking for is quick way to insert documentation in Xcode similar to what Eclipse does when editing Java files.

Let's say I have an objective-c method with a couple of arguments like this:

-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

In Eclipse, if you place the cursor above the method and type: /**<Enter> you get a Javadoc template pre-populated with @param and @return tags.

Is it possible to achieve something similar in Xcode? After typing /**<Enter>, I'd like to get this automatically:

/**
 *
 * @param one
 * @param two
 * 
 * @return
 */
 -(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

© Stack Overflow or respective owner

Related posts about objective-c

Blocking access to websites with objective-C / root privileges in objective-C

as seen on Stack Overflow - Search for 'Stack Overflow'
I am writing a program in Objective-C (XCode 3.2, on Snow Leopard) that is capable of either selectively blocking certain sites for a duration or only allow certain sites (and thus block all others) for a duration. The reasoning behind this program is rather simple. I tend to get distracted when I… >>> More
Objective-C with some Objective-C++, calling a normal c++ method "referenced from" problem

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I made an Objective-C project for the iPhone. I had only one cpp class, the soundEngine taken from some Apple demo. Now I'm trying to merge OpenFeint which is coded in Objective-C++. As soon as I drop in the code without even referring to it from my code, when I hit Build, my Objective-C code… >>> More
Add an objective @property attribute in objective-c

as seen on Stack Overflow - Search for 'Stack Overflow'
Does anyone know of a way to add additional attribute types to the @property keyword without modifying the compiler? Or can anyone think of another way to genericize getter/setter creation? Basically, I have a lot of cases in a recent project where it's handy for objects to lazily instantiate their… >>> More
ObjectiveC Syntax for Specifying Protocol Name in Method Argument

as seen on Stack Overflow - Search for 'Stack Overflow'
What's the ObjectiveC syntax for specifying a protocol as an argument in a method? Say I have 2 protocols, MyProtocol and MyProtocolCB: @protocol MyProtocolCB <NSObject> - (void) func; @end @protocol MyProtocol <NSObject> - (void) register:(MyProtocolCB*) cb; @end I'm receiving this… >>> More
ObjectiveC builtin template system ?

as seen on Stack Overflow - Search for 'Stack Overflow'
I am developing an iPhone application and I use HTML to display formatted text. I often display the same webpage, but with a different content. I would like to use a template HTML file, and then fill it with my diffent values. I wonder if ObjectiveC has a template system similar to ERB in Ruby. That… >>> More

Related posts about xcode

Xcode 3 or Xcode 4

as seen on Programmers - Search for 'Programmers'
Hi. I'm starting to learn development for the mac (then I'll learn iOS development). I just buy an iOS developer program, and I see there are 2 IDEs available for download: Xcode 3.x and Xcode 4 (GM Status). So I don't know where to start. Site's says that Xcode 4 its now "integrated" so there is… >>> More
Running Xcode Applications without installing Xcode

as seen on Stack Overflow - Search for 'Stack Overflow'
I know nothing about Xcode, except it's a Developer interface from Apple that actually comes on OSX CD and it's used to create iPhone apps as well. I also know it have a Applications folder, filled with little utilities, that are indeed quite useful. I tried grabbing one of them and running, without… >>> More
From Xcode 3.2.2 to Xcode 3.2.3

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi Everyone! Yesterday I felt in big issue that happens with all my projects. After I installed new Xcode 3.2.3 (for iPhone OS 4), all my projects started to spit out the "referenced from:" errors. I noticed that in new Xcode all the iPhone SDK versions earlier than 3.2 removed. But I have a projects… >>> More
Xcode : How to add support OS 3.0 in XCode 3.2.3

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, Is there any way to detect the SDK prior to 3.1.3 in the latest XCode that is 3.2.3. Looking for answers. Thank You. >>> More
XCode vs VS2008 or how to work with a static library project on XCode

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello. I've working with Visual Studio for a long time and now I'm working with XCode. On Visual Studio I can work with more than one project at the same time adding them to a solution (imagine a solutin with a windows application project and a library project). Now I have XCode and two projects:… >>> More