SyntaxGeneratorTemplate.WriteWithLineBreakIfNeeded Method

Definition

Namespace

Sandcastle.Core.BuildAssembler.SyntaxGenerator

Assembly

Sandcastle.Core.dll

This is used to write a string followed by an optional line break if needed (the writer position is past the maximum position afterwards).

public static bool WriteWithLineBreakIfNeeded(SyntaxWriter writer, string text, string indent)

Parameters

writer SyntaxWriter

The syntax writer to use

text string

An optional text string to write before the new line

indent string

An optional indent to write after the line break

Returns

bool

True if a new line was written, false if not