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 as source for the reference documentation #4

Open
obfischer opened this issue Sep 19, 2015 · 1 comment
Open

Use Javadoc as source for the reference documentation #4

obfischer opened this issue Sep 19, 2015 · 1 comment
Assignees
Labels
topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user

Comments

@obfischer
Copy link
Contributor

I discussed with Michael the idea of using our Javadoc as source for our Asciidoctor based documentation. The idea is to have e.g. the definition of label A and relation B written as Javadoc in Asciidoctor and to include the relevant parts via Asciidoctor's include statement.

This would require to switch from the standard Javadoclet to the Asciidoctor doclet for writing our Javadoc.

We see here a lot of potential to have the relevant documention maintained in one place and not in many.

Please comment our sight on this in this comment.

@obfischer
Copy link
Contributor Author

See https://github.com/asciidoctor/asciidoclet for information on writing Javadoc with Asciidoctor.

@obfischer obfischer self-assigned this Feb 6, 2016
@obfischer obfischer transferred this issue from jQAssistant/jqassistant Feb 28, 2020
@obfischer obfischer added topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user labels Feb 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:documentation Changes or enhancements to the documentation are necessary for this issue type:task A piece of work that must be done, but does not represent a noticeable change for the user
Projects
None yet
Development

No branches or pull requests

1 participant