search

cesarParra / apexdocs

Node.js tool to generate documentation for your Salesforce Apex Classes.
https://www.npmjs.com/package/@cparra/apexdocs
MIT License
109 stars 18 forks source link

No docGenerator function in export #46

Closed alpha-bytes closed 2 years ago

alpha-bytes commented 2 years ago

Good afternoon. Just installed from npm @ v2.2.2 and tried importing into my nodejs script. The documentation indicates there's a docGenerator function that should be part of the export but I wasn't able to find it anywhere:

If you are just interested in the documentation parsing capabilities, you can import ApexDocs into your own project.

Use the docGenerator function to create a list of ClassModel that includes all the parsed information from your .cls files [...]

cesarParra commented 2 years ago

Ah, that's my bad. That note was for versions 1.X. For versions 2.X on the parsing logic has been moved to its own module: https://www.npmjs.com/package/@cparra/apex-reflection

Hopefully that helps. I will update the docs to clarify

cesarParra commented 2 years ago

Closing this for now. Feel free to reopen if you face any other issues.