dubey/WebGoat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixining all the javadoc issues preventing the release

Browse Source 
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 <dm@corp.io>
This commit is contained in:
Doug Morato
2016-01-31 23:14:50 -05:00
parent 35a39777af
commit 6320c2d22d
43 changed files with 215 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
webgoat-container/src/main/java/org/owasp/webgoat/session/Authorization.java
View File

@ -32,6 +32,9 @@ import java.util.Map;
* projects.
*
* * @version $Id: $Id
*
* @author dm
* @version $Id: $Id
*/
public class Authorization
{

5
webgoat-container/src/main/java/org/owasp/webgoat/session/Course.java
View File

@ -322,6 +322,11 @@ public class Course {
return null;
}
/**
* <p>loadLessonFromPlugin.</p>
*
* @param context a {@link javax.servlet.ServletContext} object.
*/
public void loadLessonFromPlugin(ServletContext context) {
logger.debug("Loading plugins into cache");
String pluginPath = context.getRealPath("plugin_lessons");

8
webgoat-container/src/main/java/org/owasp/webgoat/session/DatabaseUtilities.java
View File

@ -141,6 +141,14 @@ public class DatabaseUtilities
* Description of the Parameter
* @param resultsMetaData
* Description of the Parameter
* @param resultsMetaData
* Description of the Parameter
* @param resultsMetaData
* Description of the Parameter
* @param resultsMetaData
* Description of the Parameter
* @param resultsMetaData
* Description of the Parameter
* @return Description of the Return Value
* @exception IOException
* Description of the Exception

16
webgoat-container/src/main/java/org/owasp/webgoat/session/ECSFactory.java
View File

@ -560,6 +560,12 @@ public class ECSFactory
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param name
* Description of the Parameter
* @param options
@ -568,6 +574,8 @@ public class ECSFactory
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @return Description of the Return Value
*/
public static Element makeSelect(boolean diffNames, Select select, String name, Vector<Option> options,
@ -586,6 +594,12 @@ public class ECSFactory
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param name
* Description of the Parameter
* @param options
@ -594,6 +608,8 @@ public class ECSFactory
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param selected
* Description of the Parameter
* @param rowsShowing
* Description of the Parameter
* @return Description of the Return Value

12
webgoat-container/src/main/java/org/owasp/webgoat/session/LabelDebugger.java
View File

@ -3,15 +3,27 @@ package org.owasp.webgoat.session;
import java.io.Serializable;
/**
* <p>LabelDebugger class.</p>
*
* @author dm
* @version $Id: $Id
*/
public class LabelDebugger implements Serializable {
private boolean isEnabled = false;
/**
* <p>isEnabled.</p>
*
* @return a boolean.
*/
public boolean isEnabled() {
return isEnabled;
}
/**
* <p>enable.</p>
*/
public void enable() {
this.isEnabled = true;
}

10
webgoat-container/src/main/java/org/owasp/webgoat/session/LessonTracker.java
View File

@ -200,6 +200,14 @@ public class LessonTracker
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param s
* Description of the Parameter
* @return Description of the Return Value
@ -335,6 +343,7 @@ public class LessonTracker
* @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.
*/
public void store(WebSession s, Screen screen)
{
@ -347,6 +356,7 @@ public class LessonTracker
* @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 user a {@link java.lang.String} object.
*/
public void store(WebSession s, Screen screen, String user)

1
webgoat-container/src/main/java/org/owasp/webgoat/session/Parameter.java
View File

@ -28,6 +28,7 @@ package org.owasp.webgoat.session;
* projects.
*
* @version $Id: $Id
* @author dm
*/
public class Parameter implements Comparable
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/RandomLessonTracker.java
View File

@ -10,6 +10,7 @@ import java.util.Properties;
* <p>RandomLessonTracker class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class RandomLessonTracker extends LessonTracker
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/Role.java
View File

@ -4,6 +4,7 @@ package org.owasp.webgoat.session;
* <p>Role class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class Role {
private String rolename;

1
webgoat-container/src/main/java/org/owasp/webgoat/session/SequentialLessonTracker.java
View File

@ -8,6 +8,7 @@ import java.util.Properties;
* <p>SequentialLessonTracker class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class SequentialLessonTracker extends LessonTracker
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/UnauthenticatedException.java
View File

@ -28,6 +28,7 @@ package org.owasp.webgoat.session;
* projects.
*
* @version $Id: $Id
* @author dm
*/
public class UnauthenticatedException extends Exception
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/UnauthorizedException.java
View File

@ -28,6 +28,7 @@ package org.owasp.webgoat.session;
* projects.
*
* @version $Id: $Id
* @author dm
*/
public class UnauthorizedException extends Exception
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/User.java
View File

@ -7,6 +7,7 @@ import java.util.Iterator;
* <p>User class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class User {
private String username;

13
webgoat-container/src/main/java/org/owasp/webgoat/session/UserTracker.java
View File

@ -172,6 +172,8 @@ public class UserTracker
* @param screen
* Description of the Parameter
* @return The lessonTracker value
* @param screen
* Description of the Parameter
* @param s a {@link org.owasp.webgoat.session.WebSession} object.
*/
public LessonTracker getLessonTracker(WebSession s, Screen screen)
@ -183,6 +185,7 @@ public class UserTracker
* <p>getLessonTracker.</p>
*
* @param s a {@link org.owasp.webgoat.session.WebSession} object.
* @param screen a {@link org.owasp.webgoat.session.Screen} object.
* @param user a {@link java.lang.String} object.
* @param screen a {@link org.owasp.webgoat.session.Screen} object.
* @return a {@link org.owasp.webgoat.session.LessonTracker} object.
@ -208,6 +211,8 @@ public class UserTracker
* @param screen
* Description of the Parameter
* @return The status value
* @param screen
* Description of the Parameter
* @param s a {@link org.owasp.webgoat.session.WebSession} object.
*/
public String getStatus(WebSession s, Screen screen)
@ -267,6 +272,14 @@ public class UserTracker
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param screen
* Description of the Parameter
* @param s
* Description of the Parameter
*/

1
webgoat-container/src/main/java/org/owasp/webgoat/session/ValidationException.java
View File

@ -28,6 +28,7 @@ package org.owasp.webgoat.session;
* projects.
*
* @version $Id: $Id
* @author dm
*/
public class ValidationException extends Exception
{

1
webgoat-container/src/main/java/org/owasp/webgoat/session/WebgoatContext.java
View File

@ -9,6 +9,7 @@ import javax.servlet.http.HttpServlet;
* <p>WebgoatContext class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class WebgoatContext {

1
webgoat-container/src/main/java/org/owasp/webgoat/session/WebgoatProperties.java
View File

@ -37,6 +37,7 @@ import java.util.Properties;
* for free software projects.
*
* @version $Id: $Id
* @author dm
*/
public class WebgoatProperties extends Properties {