Vvdocumenter-xcode plug-in which helps you write Javadoc style documents easier.

Links: Vvdocumenter-xcode

What's this?

Writing document is a important for developing, but it's really painful with Xcode. Think about how much time is wasting in pressing ' * ' or '/', and typing the parameters again and again. Now, you can find the method (or any code) of you want to document to, and type /// in, the document is generated for You and all params and return would be extracted to a Javadoc style, which is compatible with Appledoc, Doxygen and Heade RDoc. You can just fill the inline placeholder tokens to finish your document.

Here's an image which can show what it exactly does.

By the To, it also supports Swift now. cheers!

How do I install and use?

The best-of-the-installing is by Alcatraz. Install Alcatraz followed by the instruction, restart your Xcode and press ??9 . You can find in the list and click the icon on left to VVDocumenter-Xcode install.

If you don't like the Alcatraz-A, you can also clone the repo. Then build the VVDocumenter-Xcode target in the Xcode project and the plug-in would automatically be installed in ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins . Relaunch Xcode and type in /// above all code you want to write a document to.

If you want to use other text beside /// of to trigger the document insertion, you can find a setting panel by clicking In the VVDocument Window menu of Xcode. You can also find some other useful options there, including setting using spaces instead of tab in the Panel or changing The format of generated documentation.

Xcode version?

This plug-in are supported in Xcode 5 and 6 (current beta). From Xcode 5, Apple added a uuid-verification to all plugins to ensure the stability when Xcode gets updated. DVTPlugInCompatibilityUUIDsthe value of in project Plist should contains current UUID of Xcode version, or the plugin does not work. Once you update your Xcode, the plugin might is disabled and you should check the newest version and built it again.

The default deployment target is 10.8. If you want to use it in a earlier OS version, you should change OS X Deployment Target (in Project info setting) to your System version.

Swift Support

Yes, this plugin supports documentation to Swift now. Check the This post from @mattt to see how to write the documentation for Swift. By using VVDocumenter-Xcode , you can just type to make the /// magic happen.

Limitations and future

The plugin is a using simulation of keyboard event to insert the doc comments for you. So it is depending the keyboard shortcut of Xcode. These kinds of operation is being used:

• Delete to Beginning of the line (??)
• Paste (? V

If you have modified these-shortcuts in your Xcode, the newset version of the plugin would isn't work correctly. Instead, you can use a earlier version such as this one (commit 03C4169FF7). Be Causion suffer an undo and redo issue.

VVDocumenter-Xcodeis now using regular expression to extract things needed, which are not the best-to-do such thing. A better approach could be using the AST, and I also having a plan to do it later if I had some more time:)

License

Vvdocumenter is published under MIT License

Copyright (c) Wei Wang (@onevcat) Permission is hereby granted, free of charge, to any person obtaining a copy ofthis Software and associated documentation files (the "Software"), to deal inthe software without restriction, including Withou T limitation the rights to use,copy, modify, merge, publish, distribute, sublicense, and/or sell copies of theSOFTWARE, an D to permit persons to whom the software are furnished to does so,subject to the following conditions:the above copyright not Ice and this permission notice shall are included in allcopies or substantial portions of the Software.the software are prov IDed "As is", without WARRANTY of any KIND, EXPRESS orimplied, including and not LIMITED to the warranties of Merchantabil ity, Fitnessfor A particular PURPOSE and noninfringement.  In NO EVENT shall the AUTHORS orcopyright holders is liable for all CLAIM, damages OR other liability, whetherin an ACTION of contract, TORT or OTHERWISE, arising from, out of or inconnection with the softwareor the use or other dealings in the software. 

Vvdocumenter-xcode plug-in which helps you write Javadoc style documents easier.