Package net.fabricmc.fernflower.api

Interface IFabricJavadocProvider

public interface IFabricJavadocProvider

Provides (optional) javadoc for Classes/Methods/Fields encountered by ClassWriter. May be set as a property in the constructor of Fernflower by using the key IFabricJavadocProvider.PROPERTY_NAME

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClassDoc(StructClass structClass)
java.lang.String	getFieldDoc(StructClass structClass, StructField structField)
java.lang.String	getMethodDoc(StructClass structClass, StructMethod structMethod)

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

See Also:

Constant Field Values

Method Detail

getClassDoc

java.lang.String getClassDoc(StructClass structClass)

getFieldDoc

java.lang.String getFieldDoc(StructClass structClass,
                             StructField structField)

getMethodDoc

java.lang.String getMethodDoc(StructClass structClass,
                              StructMethod structMethod)