Package com.intellij.psi.codeStyle

Class DocCommentSettings.Defaults

java.lang.Object

com.intellij.psi.codeStyle.DocCommentSettings.Defaults

All Implemented Interfaces:

DocCommentSettings

Enclosing interface:

DocCommentSettings

public static final class DocCommentSettings.Defaults
extends java.lang.Object
implements DocCommentSettings

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.codeStyle.DocCommentSettings

DocCommentSettings.Defaults

Field Summary

Fields inherited from interface com.intellij.psi.codeStyle.DocCommentSettings

DEFAULTS

Constructor Summary

Constructors

Constructor and Description
Defaults()

Method Summary

Modifier and Type	Method and Description
boolean	isDocFormattingEnabled()
boolean	isLeadingAsteriskEnabled()
boolean	isRemoveEmptyTags()
void	setDocFormattingEnabled(boolean formattingEnabled) Enable or disable doc comment formatting.
void	setRemoveEmptyTags(boolean removeEmptyTags) Force or disable empty tags removal.

Methods inherited from class java.lang.Object

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

Constructor Detail

Defaults

public Defaults()

Method Detail

isDocFormattingEnabled

public boolean isDocFormattingEnabled()

Specified by:

isDocFormattingEnabled in interface DocCommentSettings

Returns:

True if doc comment formatting enabled.

setDocFormattingEnabled

public void setDocFormattingEnabled(boolean formattingEnabled)

Description copied from interface: DocCommentSettings

Enable or disable doc comment formatting.

Specified by:

setDocFormattingEnabled in interface DocCommentSettings

Parameters:

formattingEnabled - The enable/disable flag.

isLeadingAsteriskEnabled

public boolean isLeadingAsteriskEnabled()

Specified by:

isLeadingAsteriskEnabled in interface DocCommentSettings

Returns:

True if a leading asterisk '*' should be inserted on a new comment line.

isRemoveEmptyTags

public boolean isRemoveEmptyTags()

Specified by:

isRemoveEmptyTags in interface DocCommentSettings

Returns:

True if at least some empty tags can to be removed.

setRemoveEmptyTags

public void setRemoveEmptyTags(boolean removeEmptyTags)

Description copied from interface: DocCommentSettings

Force or disable empty tags removal.

Specified by:

setRemoveEmptyTags in interface DocCommentSettings

Parameters:

removeEmptyTags - True if all empty tags must be removed, false if all of them must be preserved.