Package com.intellij.psi.codeStyle

Interface DocCommentSettings

All Known Implementing Classes:

DocCommentSettings.Defaults

public interface DocCommentSettings

A set of code documentation comment settings if supported by a language used in common doc comment handling algorithms.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocCommentSettings.Defaults

Field Summary

Fields

Modifier and Type	Field and Description
static DocCommentSettings	DEFAULTS Default doc comment settings if not provided by LanguageCodeStyleSettingsProvider

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.

Field Detail

DEFAULTS

static final DocCommentSettings DEFAULTS

Default doc comment settings if not provided by LanguageCodeStyleSettingsProvider

Method Detail

isDocFormattingEnabled

boolean isDocFormattingEnabled()

Returns:

True if doc comment formatting enabled.

setDocFormattingEnabled

void setDocFormattingEnabled(boolean formattingEnabled)

Enable or disable doc comment formatting.

Parameters:

formattingEnabled - The enable/disable flag.

isLeadingAsteriskEnabled

boolean isLeadingAsteriskEnabled()

Returns:

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

isRemoveEmptyTags

boolean isRemoveEmptyTags()

Returns:

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

setRemoveEmptyTags

void setRemoveEmptyTags(boolean removeEmptyTags)

Force or disable empty tags removal.

Parameters:

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