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

Add JavaDoc #1209

Closed
kamuffe opened this issue Apr 12, 2018 · 4 comments
Closed

Add JavaDoc #1209

kamuffe opened this issue Apr 12, 2018 · 4 comments

Comments

@kamuffe
Copy link

kamuffe commented Apr 12, 2018

As a developer it is really hard to use Serenity and write code without JavaDoc.

Please add JavaDoc for all Classes/Methods/Constants explaining what they do and maybe provide some coding examples there as well to simplify developers live.

See WebTester as an example or Spring. These frameworks are easy to use and well explained.

@wakaleo
Copy link
Member

wakaleo commented Apr 13, 2018

Javadocs are certainly useful, and would be a good way for anyone who wants to contribute to help out and give back to the community.

@wakaleo
Copy link
Member

wakaleo commented Apr 13, 2018

(The Spring source code is certainly well documented, but is supported by a much larger company with much more resources than the majority of open source projects, this one included).

@kamuffe
Copy link
Author

kamuffe commented Apr 15, 2018

Your right.

But every developer should document the code he/she wrote. The effort is low when writing a method and immediately writing JavaDoc.

@wakaleo
Copy link
Member

wakaleo commented Apr 15, 2018

Thank you for your comments, I'm sure the community volunteers who contribute their time and skills for the benefit of other developers will take them into consideration for future pull requests.

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

No branches or pull requests

2 participants