Apex Docs
Automating Documentation for Salesforce Applications
Presented by Scott Covert / @scottbcovert
Don't Be Lazy!
JavaDoc Meets Salesforce
/**
* @author Scott Covert
* @date 3/14/2016
* @description Helper Methods for Account Trigger Handling
*/
public with sharing class AccountHelper {
/** Constant representing Salesforce Website */
private static final String salesforceSite = 'www.salesforce.com';
/**
* @author Scott Covert
* @date 3/14/2016
* @description Updates website field of given accounts to the Salesforce homepage
* @param List A list of accounts that should have their website field updated
* @return List A list of accounts with their website field set to the Salesforce homepage
*/
public static List<Account> updateWebsiteToSF(List<Account> accountList){
for(Account acct : accountList) {
acct.Website = salesforceSite;
}
return accountList;
}
}
Ant Friendly
<delete dir="${basedir}/Documentation" />
<mkdir dir="${basedir}/Documentation" />
<arg line="-s src/classes -t Documentation/ -a docAuthor.txt -h docHome.txt -p global,public,private,protected" />
Resources
