capital.scalable.restdocs.javadoc

Interface JavadocReader

All Known Implementing Classes:

JavadocReaderImpl

public interface JavadocReader

Method Summary

Methods

Modifier and Type	Method and Description
String	resolveFieldComment(Class<?> javaBaseClass, String javaFieldName)
String	resolveFieldTag(Class<?> javaBaseClass, String javaFieldName, String tagName)
String	resolveMethodComment(Class<?> javaBaseClass, String javaMethodName)
String	resolveMethodParameterComment(Class<?> javaBaseClass, String javaMethodName, String javaParameterName)
String	resolveMethodTag(Class<?> javaBaseClass, String javaMethodName, String tagName)

Method Detail

resolveFieldComment

String resolveFieldComment(Class<?> javaBaseClass,
                         String javaFieldName)

resolveFieldTag

String resolveFieldTag(Class<?> javaBaseClass,
                     String javaFieldName,
                     String tagName)

resolveMethodComment

String resolveMethodComment(Class<?> javaBaseClass,
                          String javaMethodName)

resolveMethodParameterComment

String resolveMethodParameterComment(Class<?> javaBaseClass,
                                   String javaMethodName,
                                   String javaParameterName)

resolveMethodTag

String resolveMethodTag(Class<?> javaBaseClass,
                      String javaMethodName,
                      String tagName)