public Class Comment

Class Inheritance

extends Content

Imports

java.io.IOException, .Writer, java.util.Objects

Class for generating a comment for HTML pages of javadoc output.

Field Summary

Modifier and Type	Field and Description
private final String	commentText

Access	Constructor and Description
public	Comment(String comment text for the comment comment) Constructor to construct a Comment object.

Modifier and Type	Method and Description
public boolean	isEmpty() Implements abstract jdk.javadoc.internal.html.Content.isEmpty. Returns true if the content is empty.
public boolean	write(Writer out, String newline, boolean atNewline) Implements abstract jdk.javadoc.internal.html.Content.write. Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator.

Inherited from jdk.javadoc.internal.html.Content:: add add addAll charCount isDiscardable isPhrasingContent stripTags toString

commentText	back to summary
private final String commentText

Comment	back to summary
public Comment(String comment) Constructor to construct a Comment object. Parameters comment:String comment text for the comment

Comment

public Comment(String comment)

Constructor to construct a Comment object.

Parameters

isEmpty	back to summary
public boolean isEmpty() Implements abstract jdk.javadoc.internal.html.Content.isEmpty. Doc from jdk.javadoc.internal.html.Content.isEmpty. Returns true if the content is empty. Annotations @Override

isEmpty

public boolean isEmpty()

Returns true if the content is empty.

Annotations

write back to summary

write	back to summary
public boolean write(Writer out, String newline, boolean atNewline) throws IOException Implements abstract jdk.javadoc.internal.html.Content.write. Doc from jdk.javadoc.internal.html.Content.write. Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator. Annotations @Override Exceptions IOException: if an error occurs while writing the output

public boolean write(Writer out, String newline, boolean atNewline) throws IOException

Writes content to a writer, using a given newline sequence, which should be either \n or the platform line separator.

Annotations

Exceptions