org.jsondoc.core.scanner.validator

Class JSONDocApiMethodDocValidator

java.lang.Object

org.jsondoc.core.scanner.validator.JSONDocApiMethodDocValidator

public class JSONDocApiMethodDocValidator
extends Object

Constructor Summary

Constructors

Constructor and Description
JSONDocApiMethodDocValidator()

Method Summary

Modifier and Type	Method and Description
static ApiMethodDoc	validateApiMethodDoc(ApiMethodDoc apiMethodDoc, JSONDoc.MethodDisplay displayMethodAs) This checks that some of the properties are correctly set to produce a meaningful documentation and a working playground.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONDocApiMethodDocValidator

public JSONDocApiMethodDocValidator()

Method Detail

validateApiMethodDoc

public static ApiMethodDoc validateApiMethodDoc(ApiMethodDoc apiMethodDoc,
                                                JSONDoc.MethodDisplay displayMethodAs)

This checks that some of the properties are correctly set to produce a meaningful documentation and a working playground. In case this does not happen an error string is added to the jsondocerrors list in ApiMethodDoc. It also checks that some properties are be set to produce a meaningful documentation. In case this does not happen an error string is added to the jsondocwarnings list in ApiMethodDoc.

Parameters:

apiMethodDoc -

Returns: