Package org.springdoc.core.providers
Interface JavadocProvider
- All Known Implementing Classes:
SpringDocJavadocProvider
public interface JavadocProvider
The interface Javadoc provider.
- Author:
- bnasslashen
-
Method Summary
Modifier and TypeMethodDescriptiongetClassJavadoc
(Class<?> cl) Gets class description.getFieldJavadoc
(Field field) Gets field javadoc.getFirstSentence
(String text) Returns the first sentence of a javadoc comment.getMethodJavadocDescription
(Method method) Gets method description.getMethodJavadocReturn
(Method method) Gets method javadoc return.getMethodJavadocThrows
(Method method) Gets method throws declaration.getParamJavadoc
(Method method, String name) Gets param javadoc.getRecordClassParamJavadoc
(Class<?> cl) Gets param descripton of record class.
-
Method Details
-
getClassJavadoc
Gets class description.- Parameters:
cl
- the class- Returns:
- the class description
-
getRecordClassParamJavadoc
Gets param descripton of record class.- Parameters:
cl
- the class- Returns:
- map of field and param descriptions
-
getMethodJavadocDescription
Gets method description.- Parameters:
method
- the method- Returns:
- the method description
-
getMethodJavadocReturn
Gets method javadoc return.- Parameters:
method
- the method- Returns:
- the method javadoc return
-
getMethodJavadocThrows
Gets method throws declaration.- Parameters:
method
- the method- Returns:
- the method throws (name-description map)
-
getParamJavadoc
Gets param javadoc.- Parameters:
method
- the methodname
- the name- Returns:
- the param javadoc
-
getFieldJavadoc
Gets field javadoc.- Parameters:
field
- the field- Returns:
- the field javadoc
-
getFirstSentence
Returns the first sentence of a javadoc comment.- Parameters:
text
- the javadoc comment's text- Returns:
- the first sentence based on javadoc guidelines
-