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 <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

View File

@ -55,6 +55,8 @@ public class LabelDebugService extends BaseService {
/**
* Reload all the plugins
*
* @return a {@link org.springframework.http.ResponseEntity} object.
*/
@RequestMapping(value = "/debug/labels.mvc")
public @ResponseBody

View File

@ -16,10 +16,22 @@ import org.springframework.web.bind.annotation.ResponseStatus;
import javax.servlet.http.HttpSession;
@Controller
/**
* <p>LessonInfoService class.</p>
*
* @author dm
* @version $Id: $Id
*/
public class LessonInfoService extends BaseService {
private static final Logger logger = LoggerFactory.getLogger(LessonMenuService.class);
/**
* <p>getLessonInfo.</p>
*
* @param session a {@link javax.servlet.http.HttpSession} object.
* @return a {@link org.owasp.webgoat.lessons.model.LessonInfoModel} object.
*/
@RequestMapping(value = "/lessoninfo.mvc", produces = "application/json")
public @ResponseBody
LessonInfoModel getLessonInfo(HttpSession session) {
@ -27,6 +39,12 @@ public class LessonInfoService extends BaseService {
return new LessonInfoModel(webSession);
}
/**
* <p>handleException.</p>
*
* @param ex a {@link java.lang.Exception} object.
* @return a {@link java.lang.String} object.
*/
@ExceptionHandler(Exception.class)
@ResponseBody
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
@ -34,6 +52,12 @@ public class LessonInfoService extends BaseService {
return "An error occurred retrieving the LessonInfoModel:" + ex.getMessage();
}
/**
* <p>getLessonInfoModel.</p>
*
* @param webSession a {@link org.owasp.webgoat.session.WebSession} object.
* @return a {@link org.owasp.webgoat.lessons.model.LessonInfoModel} object.
*/
protected LessonInfoModel getLessonInfoModel(WebSession webSession) {
return new LessonInfoModel(webSession);
}

View File

@ -14,6 +14,7 @@ import org.springframework.web.bind.annotation.ResponseBody;
* <p>LessonTitleService class.</p>
*
* @version $Id: $Id
* @author dm
*/
public class LessonTitleService extends BaseService {

View File

@ -56,7 +56,8 @@ public class PluginReloadService extends BaseService {
/**
* Reload all the plugins
*
* @param session a {@link HttpSession} object.
* @param session a {@link javax.servlet.http.HttpSession} object.
* @return a {@link org.springframework.http.ResponseEntity} object.
*/
@RequestMapping(value = "/reloadplugins.mvc")
public @ResponseBody