apex-specs-generator

This is a gulp task, which automatically generates any specification documents of Apex classes or triggers in markdown format.

How to use

download

git clone https://github.com/takahitomiyamoto/apex-specs-generator.git

cd apex-specs-generator

rm -rf .git

yarn install && yarn gulp:init

setup

• environment.json
• Private Key and Certificate
• Connected App

enjoy!!

yarn gulp:specs:apex:generate && yarn prettier

Example

cd ..

git clone https://github.com/trailheadapps/apex-recipes

cd apex-recipes

sfdx force:org:create -a apex-recipes -s -f config/project-scratch-def.json -v DevHub

sfdx force:source:push -u apex-recipes

sfdx force:org:open -u apex-recipes

# TODO: create a connected app

cd apex-specs-generator

# TODO: update environment.json

yarn gulp:specs:apex:generate && yarn prettier

You can see your Apex specification documents in docs/.

Acknowledgments

• ApexDoc
• TypeDoc