Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Added exceptions #75

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Conversation

mlockett
Copy link

Added the ability to include a comma delimited list of exceptions a method might throw. E.g.

/**

  • @Exceptions MyCustomException1, MyCustomException2
    */

I consider it very useful in knowing how to call a method, especially given that Apex doesn't support the throws keyword as in Java.

@no-stack-dub-sack
Copy link

no-stack-dub-sack commented Feb 10, 2019

@mlockett nice PR! Maybe someone should fork this as ApexDoc2 and try to pick up steam for it again? I forked it locally and added a few things:

  • words wrapped in backticks become code, e.g. `String cool = 'cool!';` becomes <code>String cool = 'cool!'<\code> (I noticed this is on your list of nice-to-haves but brackets instead of backticks I think...
  • command line argument to sort methods, inner classes, and properties in alphabetical or "logical" order (i.e. the order they appear in source)
  • command line argument to hide method descriptions in TOC and fixed CSS for when not hidden
  • command line argument for adding document title to docs in place of index.html

If I forked as ApexDoc2 would you re-submit this PR there? I think this is a cool project and much needed for Apex, a shame to let it completely waste away 🙁

@mlockett
Copy link
Author

@no-stack-dub-sack Nice additions. I agree it would be a shame for the project to die. I'd certainly submit a pull request if you'd like to pick the project back up!

@no-stack-dub-sack
Copy link

@mlockett I think I am going to try to get this going again, at least for myself! I hope you don't mind, I already added in your changes, but I will most definitely give you the proper credit for it (we'll see if anyone becomes interested in this anyway). I also added @see support, which I got from your nice-to-haves list as well. I'll let you know when I get this all pushed up to my public account.

@no-stack-dub-sack
Copy link

no-stack-dub-sack commented Feb 15, 2019

@mlockett Tagged you on the first PR with these changes, and credited you in the changelog and commit message for the updates!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants