io.virtdata.processors

Interface DocCtorData

All Known Implementing Classes:

DocForFuncCtor

public interface DocCtorData

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getArgs()
String	getClassName()
String	getCtorJavaDoc()
List<List<String>>	getExamples()

Method Detail

getClassName

String getClassName()

Returns:

the Class.getSimpleName() of the documented ctor.

getCtorJavaDoc

String getCtorJavaDoc()

Returns:

javadoc for the documented ctor, or null if it isn't provided

getArgs

Map<String,String> getArgs()

Returns:

an ordered map of the arguments of the documented constructor in name,type form.

getExamples

List<List<String>> getExamples()

Returns:

a list of examples, where each is list of (example syntax, comment..)