Package org.jdrupes.mdoclet.internal.doclets.formats.html.markup

Klasse Comment

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.Content

org.jdrupes.mdoclet.internal.doclets.formats.html.markup.Comment

public class Comment
extends Content

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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Comment(String comment)	Constructor to construct a Comment object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	isEmpty()	Returns true if the content is empty.
boolean	write(Writer out, String newline, boolean atNewline)	Writes content to a writer, using a given newline sequence, which should be either \n or the platform line separator.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.Content

add, add, addAll, charCount, isDiscardable, toString

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

Comment

public Comment(String comment)

Constructor to construct a Comment object.

Parameter:

comment - comment text for the comment

Methodendetails

isEmpty

public boolean isEmpty()

Beschreibung aus Klasse kopiert: Content

Returns true if the content is empty.

Angegeben von:

isEmpty in Klasse Content

Gibt zurück:

true if no content to be displayed else return false

write

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

Beschreibung aus Klasse kopiert: Content

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

Angegeben von:

write in Klasse Content

Parameter:

out - the writer

newline - the newline sequence to use

atNewline - whether the writer has just written a newline

Gibt zurück:

whether the writer has just written a newline

Löst aus:

IOException - if an error occurs while writing the output