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

javadoc warnings #29

Closed
hendriks73 opened this issue Aug 18, 2022 · 1 comment
Closed

javadoc warnings #29

hendriks73 opened this issue Aug 18, 2022 · 1 comment

Comments

@hendriks73
Copy link

Somewhat cosmetic: When creating docs, javadoc warns about a number of missing @param and @return tags:

/Users/hendrik/Projects/Panako/src/main/java/be/panako/cli/Application.java:191: warning: no @param for defaultValue
        protected int getIntegerOption(String option,int defaultValue, String... arguments){
                      ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/strategy/olaf/OlafEventPoint.java:70: warning: no @param for m
        public OlafEventPoint(final int t, final int f, final float m){
               ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/strategy/QueryResult.java:82: warning: no @param for queryPath
        public QueryResult(String queryPath,
               ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/strategy/QueryResult.java:82: warning: no @param for refPath
        public QueryResult(String queryPath,
               ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/strategy/QueryResult.java:82: warning: no @param for refStop
        public QueryResult(String queryPath,
               ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/strategy/QueryResult.java:82: warning: no @param for percentOfSecondsWithMatches
        public QueryResult(String queryPath,
               ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/util/Hamming.java:59: warning: no @param for x
            public static int d(long x, long y) {
                              ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/util/Hamming.java:59: warning: no @param for y
            public static int d(long x, long y) {
                              ^
/Users/hendrik/Projects/Panako/src/main/java/be/panako/util/Hamming.java:59: warning: no @return
            public static int d(long x, long y) {
@JorenSix
Copy link
Owner

The warnings have been fixed.

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