Package org.springdoc.core
Interface JavadocProvider
-
public interface JavadocProviderThe interface Javadoc provider.- Author:
- bnasslashen
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetFieldJavadoc(Field field)StringgetMethodJavadocDescription(Method method)Gets method description.StringgetMethodJavadocReturn(Method method)Gets method javadoc return.StringgetParamJavadoc(Method method, String name)Gets param javadoc.
-
-
-
Method Detail
-
getMethodJavadocDescription
String getMethodJavadocDescription(Method method)
Gets method description.- Parameters:
method- the method- Returns:
- the method description
-
getMethodJavadocReturn
String getMethodJavadocReturn(Method method)
Gets method javadoc return.- Parameters:
method- the method- Returns:
- the method javadoc return
-
getParamJavadoc
String getParamJavadoc(Method method, String name)
Gets param javadoc.- Parameters:
method- the methodname- the name- Returns:
- the param javadoc
-
-