WrenSecurity / WrenSecurity/wrenicf-java-framework

Multiple Javadoc warnings

Aperta
#2 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug
Lingua principale
Java
Stelle
2
Fork
9
Merge medio
7h 41m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia facendo il checkout dei commit 1.5.0.0 o 1.5.1.0 elencati ed esegui WREN_DEFAULT_MVN_COMPILE_ARGS="-DskipTests" wren-deploy compile-current-release. Confronta l'output con i log filtrati allegati, quindi correggi i tag mancanti e i riferimenti errati segnalati nei Javadocs interessati. Il lavoro è completato quando la build riesce senza avvisi Javadoc.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.