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

Creation of javadocs reports warnings #22

Open
errantlinguist opened this issue Jul 20, 2016 · 1 comment
Open

Creation of javadocs reports warnings #22

errantlinguist opened this issue Jul 20, 2016 · 1 comment

Comments

@errantlinguist
Copy link
Contributor

When creating javadocs for the different (sub-)projects, a number of warnings are thrown due to malformed comments, e.g.

[WARNING] Javadoc Warnings
[WARNING] /home/local/UKP/shore/src/com.github.errantlinguist/dkpro-argumentation/de.tudarmstadt.ukp.dkpro.argumentation.preprocessing/src/main/java/de/tudarmstadt/ukp/dkpro/argumentation/preprocessing/annotation/ArgumentSimplifiedTokenBIOAnnotator.java:80: warning: no description for @throws
[WARNING] * @throws AnalysisEngineProcessException
[WARNING] ^
[WARNING] /home/local/UKP/shore/src/com.github.errantlinguist/dkpro-argumentation/de.tudarmstadt.ukp.dkpro.argumentation.preprocessing/src/main/java/de/tudarmstadt/ukp/dkpro/argumentation/preprocessing/annotation/ArgumentSimplifiedTokenBIOAnnotator.java:140: warning: no description for @throws
[WARNING] * @throws AnalysisEngineProcessException
[WARNING] ^

These comments should be fixed so that the javadoc generator doesn't throw any warnings (which might hide other, more dangerous warnings due to their frequency).

@errantlinguist
Copy link
Contributor Author

Many of these warnings have been fixed in the fork to be pulled in pull request no. 20.

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

1 participant