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

Missing javadoc for functions #1202

Open
Tejas2805 opened this issue Apr 1, 2020 · 4 comments
Open

Missing javadoc for functions #1202

Tejas2805 opened this issue Apr 1, 2020 · 4 comments

Comments

@Tejas2805
Copy link
Contributor

@Tejas2805 Tejas2805 commented Apr 1, 2020

There are many methods in the backend which don't have any javadoc This makes it difficult for first-time developers to understand the backend code.

Suggestion: Let's add javadoc for missing functions so that it becomes easier for someone reading the code to do it.

@Tejas2805
Copy link
Contributor Author

@Tejas2805 Tejas2805 commented Apr 1, 2020

Let's make this a FirstTimer issue? It will help them understand the backend better.

@anubh-v
Copy link
Contributor

@anubh-v anubh-v commented Apr 1, 2020

Which methods are you referring to? (any specific classes / package ? )
It may be better if we can identify where the documentation is needed

@Tejas2805
Copy link
Contributor Author

@Tejas2805 Tejas2805 commented Apr 1, 2020

The addAuthorEmailsAndAliasesMapEntry in AuthorConfiguration for example doesn't have it. Though it is not something too important to add, such methods when edited, cause an error in Travis, due to having no javadoc. Therefore, I feel it is better to find such methods and add them.

@anubh-v
Copy link
Contributor

@anubh-v anubh-v commented Apr 4, 2020

I think our checkstyle config does check for presence of javadocs.
Perhaps we can investigate if the config is sufficiently strict in detecting missing javadoc comments?

For the specific case you mentioned, I think it can be a first timer issue, but perhaps issue #1207 should be resolved first as it affects the same data structure

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.