Package org.springdoc.core.providers
Interface JavadocProvider
-
public interface JavadocProvider
The interface Javadoc provider.- Author:
- bnasslashen
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getFieldJavadoc(Field field)
String
getMethodJavadocDescription(Method method)
Gets method description.String
getMethodJavadocReturn(Method method)
Gets method javadoc return.String
getParamJavadoc(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
-
-