All Ideas

Idea Details

Upvote Downvote

Post an Idea

2,270 Points

Closed - Low Activity

Chris Matthews

Doc Generation Support for API/Guides/Apps/etc

Developer Tools

Provide an generate documents for APEX Class/Triggers/Code/etc similar to Java Doc solution for partners/developers to easily document their code/designs/apis/etc for end users/third parties/etc as a software as a service. - Documents generated could be displayed in HTML Form like salesforce developer documentation - Documents could be downloaded in PDF format for offline use - Document tags would be available to markup code, embed images, documents, etc into final form document - Custom Document handers could be created in APEX to handle specialized document types (doclets)

Merge Idea · Flag

Comments ( 20 )

Sort By

trail head - 2 months ago

yes
- Flag

Deborah Orth - 6 months ago

Thanks for the update @Steve Cox! I didn't know you had come out with a newer version, but am glad to see the @throws get implemented. I am a big fan of SfApexDocs and have been using it for over 5 years now. I regularly run training sessions on its usage for others at my employer as well.

Flag

Steve Cox - 1 year ago

Hey all - I just posted a new version of SfApexDoc

parses javadoc-style comments and creates HTML documentation
recognizes standard tags such as @description, @author, @date, @return, @param, @see, and @throws
creates links to standard Apex types as well as your own classes
includes full class, method, and property signatures - even those that span multiple lines
allows customization of output styling

Flag

Steve Cox - 1 year ago

I just posted a new version of SfApexDoc. Check out the release notes, documentation format, and usage details.

parses javadoc-style comments and creates HTML documentation
recognizes standard tags such as @description, @author, @date, @return, @param, @see, and @throws
creates links to standard Apex types as well as your own classes
includes full class, method, and property signatures - even those that span multiple lines
allows customization of output styling

Flag

Víctor Manuel Andrés Pascual - 2 years ago

Yes
- Flag
Gabor Nemeth - 3 years ago

Even if there is no doc generation, a general support for Javadoc would be nice.
- Flag
Michael Lanz - 5 years ago

This would be extremely useful! Make it happen please :)
- Flag
Alexander Muravyov - 7 years ago

Yep, makes sense!
- Flag

Steve Cox - 7 years ago

I've made some improvements to ApexDoc. Check out the writeup here:http://scox67.blogspot.com/2013/08/sf-apexdoc.html.

In a nutshell, SfApexDoc:

Parses javadoc-style comments and creates HTML documentation
recognizes standard tags such as @description, @author, @date, @return, @param, @see.
creates links to standard Apex types as well as your own classes
includes full class, method, and property signatures - even those that span multiple lines.

I'm actively working on fixing issues and adding features, so please send me a note if you find problems.

Flag

Carrie Marciano - 8 years ago

Definitely a great idea and much needed.
- Flag
Matthew Nesci - 8 years ago

This would be a huge help to our ORG!
- Flag

Dan Carmen - 8 years ago

Would love for this to be documentation that can be viewed from within Salesforce, so even non-developer type of people can easily read the documentation without having to sort through the code. And I know I am definitely better at updating comments within code I'm working on rather than going to find another document somewhere to update...

Flag

cynthia susairaj - 8 years ago

Really need java docs for the APEX classes please... I know we can find it from the web view but it would be awesome to get it while typing.
- Flag
Mike McMahon - 8 years ago

This is something we definitely need in our code/org!
- Flag
Sarah Burns - 8 years ago

this should just be standard...
- Flag

Chris Matthews

12 years ago

2,270 Points Closed - Low Activity

| 2 Merged Ideas

Ideas

Apps

from AppExchange

Questions

No results found.

COVID-19

All Ideas

Idea Details

Comments ( 20 )

Ideas

Apps

Questions

Links

Salesforce

Need Help?