Interface DocCtorData

All Known Implementing Classes:
DocCtorDataView, DocForFuncCtor
public interface DocCtorData

  • Method Details

    • 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..)