From 6320c2d22d8bca3fc5dabec5c53838646d4809bf Mon Sep 17 00:00:00 2001
From: Doug Morato
Date: Sun, 31 Jan 2016 23:14:50 -0500
Subject: [PATCH] Fixining all the javadoc issues preventing the release
In order to perfom a Sonatype OSS release, all the javadocs must pe corretly and completely parsed in order to pass the release requirement.
This comment is only adding "comments' pertaining to javadoc. NO CODE HAS BEEN CHANGED
Signed-off-by: Doug Morato
---
.../java/org/owasp/webgoat/HammerHead.java | 1 +
.../application/WebGoatServletListener.java | 8 +---
.../owasp/webgoat/lessons/AbstractLesson.java | 6 ++-
.../owasp/webgoat/lessons/LessonAdapter.java | 6 ++-
.../webgoat/lessons/LessonServletMapping.java | 7 +++-
.../webgoat/lessons/RandomLessonAdapter.java | 4 ++
.../lessons/SequentialLessonAdapter.java | 2 +
.../admin/MenuToLessonMapperScreen.java | 2 +-
.../lessons/model/HttpBasicsModel.java | 1 +
.../lessons/model/LessonInfoModel.java | 41 +++++++++++++++++++
.../org/owasp/webgoat/plugins/Plugin.java | 11 +++++
.../webgoat/plugins/PluginExtractor.java | 23 ++++++++++-
.../webgoat/plugins/PluginFileUtils.java | 1 +
.../webgoat/plugins/PluginLoadingFailure.java | 1 +
.../owasp/webgoat/plugins/PluginsLoader.java | 1 +
.../webgoat/service/LabelDebugService.java | 2 +
.../webgoat/service/LessonInfoService.java | 24 +++++++++++
.../webgoat/service/LessonTitleService.java | 1 +
.../webgoat/service/PluginReloadService.java | 3 +-
.../owasp/webgoat/servlets/Controller.java | 1 +
.../owasp/webgoat/session/Authorization.java | 3 ++
.../org/owasp/webgoat/session/Course.java | 5 +++
.../webgoat/session/DatabaseUtilities.java | 8 ++++
.../org/owasp/webgoat/session/ECSFactory.java | 16 ++++++++
.../owasp/webgoat/session/LabelDebugger.java | 12 ++++++
.../owasp/webgoat/session/LessonTracker.java | 10 +++++
.../org/owasp/webgoat/session/Parameter.java | 1 +
.../webgoat/session/RandomLessonTracker.java | 1 +
.../java/org/owasp/webgoat/session/Role.java | 1 +
.../session/SequentialLessonTracker.java | 1 +
.../session/UnauthenticatedException.java | 1 +
.../session/UnauthorizedException.java | 1 +
.../java/org/owasp/webgoat/session/User.java | 1 +
.../owasp/webgoat/session/UserTracker.java | 13 ++++++
.../webgoat/session/ValidationException.java | 1 +
.../owasp/webgoat/session/WebgoatContext.java | 1 +
.../webgoat/session/WebgoatProperties.java | 1 +
.../org/owasp/webgoat/util/BeanProvider.java | 1 +
.../org/owasp/webgoat/util/HtmlEncoder.java | 1 +
.../org/owasp/webgoat/util/LabelManager.java | 1 +
.../owasp/webgoat/util/LabelManagerImpl.java | 1 +
.../org/owasp/webgoat/util/LabelProvider.java | 1 +
.../org/owasp/webgoat/util/WebGoatI18N.java | 1 +
43 files changed, 215 insertions(+), 14 deletions(-)
diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java b/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java
index 0f94399fe..2c70201de 100644
--- a/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java
+++ b/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java
@@ -412,6 +412,7 @@ public class HammerHead extends HttpServlet {
*
* @param s Description of the Parameter
* @param screen a {@link org.owasp.webgoat.session.Screen} object.
+ * @param screen a {@link org.owasp.webgoat.session.Screen} object.
* @param response Description of the Parameter
* @exception IOException Description of the Exception
* @throws java.io.IOException if any.
diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java b/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java
index b5385f9fd..270dc434e 100644
--- a/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java
+++ b/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java
@@ -41,9 +41,7 @@ public class WebGoatServletListener implements ServletContextListener {
private static final Logger logger = LoggerFactory.getLogger(HammerHead.class);
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void contextInitialized(ServletContextEvent sce) {
ServletContext context = sce.getServletContext();
@@ -80,9 +78,7 @@ public class WebGoatServletListener implements ServletContextListener {
new PluginsLoader(Paths.get(pluginPath), Paths.get(targetPath)).loadPlugins();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void contextDestroyed(ServletContextEvent sce) {
ServletContext context = sce.getServletContext();
diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java
index 13c0ef809..5598af3b1 100644
--- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java
+++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java
@@ -233,6 +233,8 @@ public abstract class AbstractLesson extends Screen implements Comparable
+ *
+ * @return a {@link java.lang.String} object.
*/
public abstract String getSubmitMethod();
@@ -647,12 +649,14 @@ public abstract class AbstractLesson extends Screen implements Comparable