org.jsondoc.core.scanner

Interface JSONDocScanner

All Known Implementing Classes:

AbstractJSONDocScanner, DefaultJSONDocScanner

public interface JSONDocScanner

Method Summary

Modifier and Type	Method and Description
Set<ApiDoc>	getApiDocs(Set<Class<?>> classes, JSONDoc.MethodDisplay displayMethodAs)
Set<ApiFlowDoc>	getApiFlowDocs(Set<Class<?>> classes, List<ApiMethodDoc> apiMethodDocs)
Set<ApiObjectDoc>	getApiObjectDocs(Set<Class<?>> classes)
JSONDoc	getJSONDoc(String version, String basePath, List<String> packages, boolean playgroundEnabled, JSONDoc.MethodDisplay methodDisplay)

Method Detail

getJSONDoc

JSONDoc getJSONDoc(String version,
                   String basePath,
                   List<String> packages,
                   boolean playgroundEnabled,
                   JSONDoc.MethodDisplay methodDisplay)

getApiDocs

Set<ApiDoc> getApiDocs(Set<Class<?>> classes,
                       JSONDoc.MethodDisplay displayMethodAs)

getApiObjectDocs

Set<ApiObjectDoc> getApiObjectDocs(Set<Class<?>> classes)

getApiFlowDocs

Set<ApiFlowDoc> getApiFlowDocs(Set<Class<?>> classes,
                               List<ApiMethodDoc> apiMethodDocs)