WrenSecurity / WrenSecurity/wrenicf-java-framework

Multiple Javadoc warnings

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Java
Stars
2
Forks
9
Avg merge
7h 41m
Merged PRs (30d)
1

Description

Versions affected

1.5.0.0 - 1.5.1.0 (probably 1.5.2.0 and master as well, though they're not buildable yet)

Repo steps

  1. checkout the project at version 1.5.0.0 (9c7a452f6eac53f9089b2f57277d7aa193dbc488) OR version 1.5.1.0 (aa812ab5750441b711e76b4998ffe7f4724d962a).
  2. execute WREN_DEFAULT_MVN_COMPILE_ARGS="-DskipTests" wren-deploy compile-current-release.

Expected

Builds succeed with no Javadoc warnings.

Actual results

There are many Javadoc warnings about missing tags and bad references.

See attached logs.
build-javadoc-1.5.0.0-filtered.log
build-javadoc-1.5.1.0-filtered.log

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking out the listed 1.5.0.0 or 1.5.1.0 commits and run WREN_DEFAULT_MVN_COMPILE_ARGS="-DskipTests" wren-deploy compile-current-release. Compare the output with the attached filtered logs, then address the reported missing tags and bad references across the affected Javadocs. Done means the build succeeds without Javadoc warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.