ApexDoc Eclipse Plugin For Force com IDE

ApexDoc Eclipse Plugin For Force com IDE

Hi All,

I am very happy to announce that now ApexDoc is available as Native "Eclipse Plugin". So no more need to go command line and provide parameters. You can simply go to your Force.IDE, select your classes folder, right click on that and Generate your ApexDoc, all in one place. Isnt it cool :)

Ok, so here is the guidelines, how to install the plugin and use it.

1) Go to http://www.aslambari.com/apexdocplugin.html

2) Download the plugin from there. It will give you one plugins.zip file. Unzip that file.

3) You will get one "com.apex.doc_1.0.0.jar" file. Copy this file.

4) Go to your eclipse installation directory and find your plugins folder there, For example D:Eclipseplugins

5) Paster the copied jar file into this directory.

6) Now restart (if eclispe is already running) your eclipse

7) Now go to any Force.com Project you have setup in your eclipse. Open the classes folder.

8) Right click on that folder, from shortcut menu select "Force.com", a sub menu will appear, you can see "Generate ApexDoc..." menu item in your submenu.

9) Now click on "Generate ApexDoc...". One ApexDoc dialog box will open.

10) All options here are self explanatory. The "Source Directory" is already filled up your selection. The "Target Directory" is where you want to generate output Documentation generated. "Home HTML File" is your sample home file for index page. "Author File" is for header areas for documentation.

11) Select appropriate options and Click on "Generate" button. It will generate documentation on your selected target directory and you will be prompted one message dialog that says "DONE"

12) If there is any issue, not generated your documentation, you can find one log file generated in your eclipse installation with name "apex_doc_log.txt".

So, this is very useful for Force.com developers and non programmers to use this plugin tool. You can also check one screenshot here: http://www.aslambari.com/apexdocplugin.html

For learning how comments syntax will be in your code refer my previous blog:
http://techsahre.blogspot.com/2011/01/apexdoc-salesforce-code-documentation.html

The plugin is in pre-mature stage and may contains bugs. Feel free to report me all bugs or enhancement you find, on my email. I will try to fix those.

So enjoy documenting :)

Thanks
Aslam Bari