Xcode Documentation Generator

Question

I've looked at Headerdoc and Doxygen for documenting source code, but they both seem to need the developer to do most of the leg-work first. In Visual Studio, typing \\\ generates the skeleton for documentation including the parameters expected by a method. There's also Ghostdoc which guesses what the method does based on its name and parameters. Is there anything similar for Xcode?

score 1 · Answer 1 · answered Dec 24 '14 at 00:47

You can use VVDocumenter plugin, it's a very handy plugin for XCode documentation.

After that you can find the method (or any code) you want to document to, and type in ///, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with Appledoc, Doxygen and HeaderDoc. You can just fill the inline placeholder tokens to finish your document.

score 1 · Answer 2 · answered Dec 26 '11 at 15:19

1

There is also Appledoc, which creates a variety of documentation from comments in your source, docsets, html that looks just like the Apple docs.

answered Dec 26 '11 at 15:19

Abizern

146,289
39
203
257

But that doesn't appear to generate the documentation skeleton. I'm not looking to generate HTML documentation, just source code documentation. – Echilon Dec 26 '11 at 16:20
I don't think so. If you don't write it I don't know of anything that would extract it from the uncommented source. – Abizern Dec 26 '11 at 16:49

score 0 · Answer 3 · answered Aug 29 '14 at 05:14

Download the XCode package manager: Alcatraz which can be done easily with the following command:

curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh

Restart XCode and you will find a new option in the Window toolbar menu labed 'Package Manager'. You can then install VVDocumenter from there.

Once you install VVDocumenter you'll need to restart XCode again, but after you reload Xcode you can then type /// to get help writing comments which will later be used to write your documentation.

Xcode Documentation Generator

3 Answers3