net.minecraftforge.gradle.util.mcp

Class JavadocAdder

java.lang.Object

net.minecraftforge.gradle.util.mcp.JavadocAdder

public final class JavadocAdder
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildJavadoc(java.lang.String indent, java.lang.String javadoc, boolean isMethod) Converts a raw javadoc string into a nicely formatted, indented, and wrapped string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

buildJavadoc

public static java.lang.String buildJavadoc(java.lang.String indent,
                            java.lang.String javadoc,
                            boolean isMethod)

Converts a raw javadoc string into a nicely formatted, indented, and wrapped string.

Parameters:

indent - the indent to be inserted before every line.

javadoc - The javadoc string to be processed

isMethod - If this javadoc is for a method or a field

Returns:

A fully formatted javadoc comment string complete with comment characters and newlines.