org.springdoc.core

Interface JavadocProvider

public interface JavadocProvider

The interface Javadoc provider.

Author:

bnasslashen

Method Summary

Modifier and Type	Method and 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 method

name - the name

Returns:

the param javadoc

getFieldJavadoc

String getFieldJavadoc(Field field)