Package io.micronaut.sourcegen.generator.visitors

Class JavadocUtils

java.lang.Object

io.micronaut.sourcegen.generator.visitors.JavadocUtils

@Internal
public class JavadocUtils
extends Object

A utility class for javadoc. Since processed task might be in a dependency, it helps with writing it javadoc info in a META-INF file and reading it from the file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JavadocUtils.TypeJavadoc	A holder of javadoc for a type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	META_INF_EXTENSION	The extension to use for javadoc files.
static final String	META_INF_FOLDER	The folder to generated javadoc files into.

Constructor Summary

Constructors

Constructor	Description
JavadocUtils()

Method Summary

Modifier and Type	Method	Description
static @NonNull JavadocUtils.TypeJavadoc	getTaskJavadoc(io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.ClassElement element)	Get the javadoc for a task.
static String	writeJavadocInfo(io.micronaut.inject.ast.ClassElement element)	Write javadoc meta info that could be parsed from a file.

Methods inherited from class java.lang.Object

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

Field Details

META_INF_FOLDER

public static final String META_INF_FOLDER

The folder to generated javadoc files into.

See Also:

• Constant Field Values

META_INF_EXTENSION

public static final String META_INF_EXTENSION

The extension to use for javadoc files.

See Also:

• Constant Field Values

Constructor Details

JavadocUtils

public JavadocUtils()

Method Details

getTaskJavadoc

@NonNull
public static @NonNull JavadocUtils.TypeJavadoc getTaskJavadoc(io.micronaut.inject.visitor.VisitorContext context,
 io.micronaut.inject.ast.ClassElement element)

Get the javadoc for a task. Task class element may be in a dependency. It will read the .javadoc.txt file written by plugin task visitor.

Parameters:

context - The visitor context

element - The element annotated with PluginTask.

Returns:

The javadoc

writeJavadocInfo

public static String writeJavadocInfo(io.micronaut.inject.ast.ClassElement element)

Write javadoc meta info that could be parsed from a file.

Parameters:

element - The source element.

Returns:

The info