cesarParra / apexdocs

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

Allow for empty @argument, @return, and other tags #51

Closed cesarParra closed 1 year ago

cesarParra commented 2 years ago

Currently the parser for docs complains about empty @argument, @return, and possible other tags where it expects some kind of body. Maybe we can allow for this without the parser complaining and simply not have a description for those that are empty

carrera328 commented 1 year ago

I'm adding a @return to my comments but not seeing that return being parse. The markdown generates a return block but my text isn't picked when the parsing is done.

cesarParra commented 1 year ago

Thanks @carrera328

I'll look into this

cesarParra commented 1 year ago

@carrera328 From your second comment I see the return information there

image

Is the issue that the text doesn't match what you have or that the current format is not clear?

carrera328 commented 1 year ago

Hey @cesarParra I see now, my mistake I misunderstood the format. Thanks for clearing this up for me.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 30 days with no activity.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 30 days with no activity.

cesarParra commented 1 year ago

After some testing this seems to be currently working.