+ Start a Discussion
Newbie_edmNewbie_edm 

How to document current apex classes, triggers, batch jobs for migration?

Hello Guys,

I am new to documentation. I got asked to document the existing class, batch jobs, triggers for migration perpose. could you guys give some idea where to start and how we can identify the class and related objects? it would be great help if you guys could provide some guidance on this.

thanks
Alain CabonAlain Cabon
Helllo Venkat,

For the automatic documentation of the classes and triggers, you can use the symbol tables.

There are no mastheads in your classes and triggers? Pure impact analysis and retro-documentation?

1) ApexDoc: (basic) I used it yet for a javadoc-look-alike.

https://github.com/SalesforceFoundation/ApexDoc

2) Use symbol tables instead of building a parser or compiler. Symbol tables allow you to do symbol highlighting, code navigation, code completion, symbol searches, and more.

https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_symboltable.htm

https://developer.salesforce.com/forums/?id=906F0000000MISBIA4

3) Apexchange probably many tools like Octopus https://appexchange.salesforce.com/listingDetail?listingId=a0N3000000B5cEKEAZ

I am interested in other answers here.

Alain 
Alain CabonAlain Cabon
The problem with the WSDL and the genereated Tool api jar is the ... bugs.

https://success.salesforce.com/issues_view?id=a1p3A0000008fsrQAA

Daniel Ballinger is folowing the bug and I found on the internet a solution (work-around) but you are building your own tools, it is a waste of time.

Alain
scox67scox67
Hey all - I just posted a new version of SfApexDoc (https://gitlab.com/StevenWCox/sfapexdoc/wikis/home). 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
Steve Fouracre 24Steve Fouracre 24
Hi If you want to produce technical documentation of your codebase and many more features I have created an app that does exactly this. If you want more information contact me at steven.fouracre@hotmail.co.uk