ApexDoc Eclipse Plugin For Force.com IDE

Tuesday, February 1, 2011 by Aslam - The Alexendra
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. Isn't 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:\Eclipse\plugins

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

25 comments:

Amit Goyal {SalesForce Share} said...

Hello aslam,
hmmm congrates and Thanks,
A good application again,
you really made ApexDoc more easier.

really appreciable achievement.
Thanks a lot.

Lokesh said...

it is privilege to use this plugin to us. It is really a spectacular display of your willing lights.
Thanks for sharing it . :)

Raj Jha said...
This comment has been removed by the author.
Raj Jha said...

Hello Sir,
Really Its a Useful Material for SalesForce Users.

You Have again done Innovative Work.

Congratulation sir for this Work.

And One More Good Thing is Your Explanation of eclipse plugin for Force.com.

Thanks For giving New Material.

Abhay said...

Aslam .. you are doing a grt job this kind of utilities will ease the job... keep up the good work ....

Abdul Vahid said...

Great Dear, Really very useful tool once again!!!

Now got the rid of typical command line :)

Anonymous said...

Very Cool!!! :)

iD0'TN0 said...

Good one Aslam - very nice and useful tool .. keep up the good work!!

Anonymous said...

Thanks! Are you planning to publish the source code and make it an open source project? I am afraid that as the API were to change and you are too busy, we might have a problem producing updates.

Cheers!

Aslam - The Alexendra said...

Will plan soon to publish the source code. Busy these days :)

Aslam - The Alexendra said...

ApexDoc Plugin Version 1.1 Released By Habib, Good work... http://code.google.com/p/apexdoc/downloads/list

Chiz said...

Target Directory. Click "Browse For Folder" button. Opens dialog to chose folder. Select "Local Disk (D:)". After this action "D:\" text appears in text field. After generating docs it asks to open. But path has is "D:\\ApexDocumentation\index.html". TWO back slashes. It cause error.
If I remove slash in text field so it will look "D:". Then it will work fine.

Chiz said...

Doc generates OK. But if no path edited then error. If D: then OK.

Anonymous said...

Seems to be an error on the plugins.zip file. Are you aware?

raaj said...

could you please let me know,in which language the code has been develop (apex or visual force ),if apex then why visual force will required .

how to write the code the eclipse..

please suggest me

Debasis

raaj said...

please suggest me,how to start this

banders5144 said...

I need a way to modify the index.html template. It seems like everything is hard-coded within the java classes.

Dex Delfrate said...

This seems awesome for my team, but when I download the plugin, the .zip file is empty... There's just nothing there...

for IT the said...

Great Article
Java Online Course | Java EE Training


Java Training Institutes in Chennai | java j2ee training institutes in chennai | Java Training in Chennai | J2EE Training in Chennai | Java Course in Chennai


Java Interview Questions | Java Training Institutes | Core Java Interview Questions

Bohdan Dovhan said...

Hello.

Download link seems to be broken.

Can anyone suggest alternative link?

Download page says:
"Not Found

The requested URL /downloads/apexdoc/plugins.zip was not found on this server.

Additionally, a 404 Not Found error was encountered while trying to use an ErrorDocument to handle the request."

Praveen Kumar said...

I have the same issue, the Download link is broken not able to download the zip folder.Can you please fix the broken link

Thanks
Praveen

Praveen Kumar said...

Hi Bohdan,

you can download the plugin for eclipse .jar file from this location

http://force-code.com/category/apexdoc/


Thanks
Praveen

shipra upadhyaya said...
This comment has been removed by the author.
shipra upadhyaya said...

Hi Aslam,
Very good and helpful tool ,But I am not able to download it from link given .It seems broken .Can you please help .

Anonymous said...

Seems to be the Link is broken. Can any one fix this one who used it or the author.
will be helpfull

Post a Comment