Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Javadoc instead of Doxygen for generated Java code? #1794

Closed
bmaclach opened this issue Aug 2, 2019 · 4 comments
Closed

Use Javadoc instead of Doxygen for generated Java code? #1794

bmaclach opened this issue Aug 2, 2019 · 4 comments
Labels

Comments

@bmaclach
Copy link
Collaborator

bmaclach commented Aug 2, 2019

@JacquesCarette raised the question in #1789 of whether we want to use javadoc for Java code documentation instead of Doxygen.

My thinking is that we could treat this like we plan to do with external libraries (#394), and allow users to choose whether they want Doxygen or Javadoc (or rather, pass in an ordered list of their preferred choices).

@JacquesCarette
Copy link
Owner

I agree with your reasoning.

@smiths
Copy link
Collaborator

smiths commented Aug 3, 2019

I agree. We should also add the option of Pydoc in the future, using similar reasoning. I don't think we should be in a hurry to generate Javadoc, or Pydoc. Generating doxygen makes the point that we can generate documentation, adding more options adds more work, but without the same payoff. As far as future enhancements go though, this is a good idea.

@JacquesCarette
Copy link
Owner

I'm thinking that we won't get to this anytime soon, so we should put it in the 'icebox' -- close the issue, but refer to it on the wiki.

@bmaclach
Copy link
Collaborator Author

Added to wiki, closing.

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

No branches or pull requests

3 participants