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

Make Javadoc publicly available #746

Closed
christerengman opened this issue Nov 13, 2020 · 3 comments
Closed

Make Javadoc publicly available #746

christerengman opened this issue Nov 13, 2020 · 3 comments

Comments

@christerengman
Copy link

User story
As a tester, I want to be able to have Javadoc easily available for reference so that I know how to use the framework on a detailed level.

Additional context
The Javadoc should be available alongside the reference documentation. Maybe I'm blind but I simply cannot find it.

Today you have to either browse the source or rely on IDE support which is not always applicable. For example if you want to browse available implementations of an abstract class or an interface. This will be even more important with Citrus Framework 3.x as it is more modular.

As a bonus, this will increase Javadoc quality as it will be more exposed.

@christophd
Copy link
Member

Please use https://javadoc.io/doc/com.consol.citrus

Maybe a good idea to add this link to the website to make it more prominent.

@christophd
Copy link
Member

@christerengman I would close this one in favor of citrusframework/citrus-website#10. Good for you?

@christerengman
Copy link
Author

Fine with me. I'll add comments there.

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

No branches or pull requests

2 participants