From ac2b38fb6c1d906bcf7d549a880bb0722841a6fb Mon Sep 17 00:00:00 2001 From: brutzman <brutzman@nps.edu> Date: Thu, 1 Jul 2021 16:20:51 -0700 Subject: [PATCH] javadoc links in package-info.java --- src/edu/nps/moves/dis7/examples/package-info.java | 15 +++++++++------ .../nps/moves/dis7/utilities/package-info.java | 15 +++++++++------ .../moves/dis7/utilities/stream/package-info.java | 15 +++++++++------ src/edu/nps/moves/spatial/package-info.java | 15 +++++++++------ 4 files changed, 36 insertions(+), 24 deletions(-) diff --git a/src/edu/nps/moves/dis7/examples/package-info.java b/src/edu/nps/moves/dis7/examples/package-info.java index 8421454dce..62bf822d3e 100644 --- a/src/edu/nps/moves/dis7/examples/package-info.java +++ b/src/edu/nps/moves/dis7/examples/package-info.java @@ -1,6 +1,9 @@ -/** - * Example classes using edu.nps.moves.dis7 library. - */ -// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java - -package edu.nps.moves.dis7.examples; +/** + * Example classes using edu.nps.moves.dis7 library. + * + * @see java.lang.Package + * @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful">https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful</a> + * @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java">https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java</a> + */ + +package edu.nps.moves.dis7.examples; diff --git a/src/edu/nps/moves/dis7/utilities/package-info.java b/src/edu/nps/moves/dis7/utilities/package-info.java index 9cf044a2b9..35d36720b8 100644 --- a/src/edu/nps/moves/dis7/utilities/package-info.java +++ b/src/edu/nps/moves/dis7/utilities/package-info.java @@ -1,6 +1,9 @@ -/** - * Utility classes supporting edu.nps.moves.dis7 library. - */ -// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java - -package edu.nps.moves.dis7.utilities; +/** + * Utility classes supporting edu.nps.moves.dis7 library. + * + * @see java.lang.Package + * @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful">https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful</a> + * @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java">https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java</a> + */ + +package edu.nps.moves.dis7.utilities; diff --git a/src/edu/nps/moves/dis7/utilities/stream/package-info.java b/src/edu/nps/moves/dis7/utilities/stream/package-info.java index b1aef3bc3a..e968228bc6 100644 --- a/src/edu/nps/moves/dis7/utilities/stream/package-info.java +++ b/src/edu/nps/moves/dis7/utilities/stream/package-info.java @@ -1,6 +1,9 @@ -/** - * Streaming utility classes supporting edu.nps.moves.dis7 library. - */ -// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java - -package edu.nps.moves.dis7.utilities.stream; +/** + * Streaming utility classes supporting edu.nps.moves.dis7 library. + * + * @see java.lang.Package + * @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful">https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful</a> + * @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java">https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java</a> + */ + +package edu.nps.moves.dis7.utilities.stream; diff --git a/src/edu/nps/moves/spatial/package-info.java b/src/edu/nps/moves/spatial/package-info.java index 24678d3243..dd216fedbe 100644 --- a/src/edu/nps/moves/spatial/package-info.java +++ b/src/edu/nps/moves/spatial/package-info.java @@ -1,6 +1,9 @@ -/** - * Spatial utility classes supporting edu.nps.moves.dis7 library. - */ -// https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java - -package edu.nps.moves.spatial; +/** + * Spatial utility classes supporting edu.nps.moves.dis7 library. + * + * @see java.lang.Package + * @see <a href="https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful">https://stackoverflow.com/questions/22095487/why-is-package-info-java-useful</a> + * @see <a href="https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java">https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java</a> + */ + +package edu.nps.moves.spatial; -- GitLab