CSF.Zpt.SourceAnnotation.ICommentFormatter Interface Reference

Service which creates formatted source annotation comments. More...

Inheritance diagram for CSF.Zpt.SourceAnnotation.ICommentFormatter:

Public Member Functions
string	GetRootElementComment (string source, string lineNumber)
	Gets the formatted comment for the root element of a ZPT document. More...
string	GetDefineMacroComment (string source, string lineNumber)
	Gets the formatted comment for a define-macro attribute. More...
string	GetDefineSlotComment (string source, string lineNumber)
	Gets the formatted comment for a define-slot attribute. More...
string	GetImportedElementComment (string source, string lineNumber)
	Gets the formatted comment for an imported element. More...
string	GetAfterImportedElementComment (string source, string lineNumber)
	Gets the formatted comment for displaying after an imported element. More...

Detailed Description

Service which creates formatted source annotation comments.

Member Function Documentation

string CSF.Zpt.SourceAnnotation.ICommentFormatter.GetAfterImportedElementComment	(	string	source,
		string	lineNumber
	)

Gets the formatted comment for displaying after an imported element.

Returns

The formatted comment.

Parameters

source	The source information for the file.
lineNumber	The line number within the file.

Implemented in CSF.Zpt.SourceAnnotation.CommentFormatter.

string CSF.Zpt.SourceAnnotation.ICommentFormatter.GetDefineMacroComment	(	string	source,
		string	lineNumber
	)

Gets the formatted comment for a define-macro attribute.

Returns

The formatted comment.

Parameters

source	The source information for the file.
lineNumber	The line number within the file.

Implemented in CSF.Zpt.SourceAnnotation.CommentFormatter.

string CSF.Zpt.SourceAnnotation.ICommentFormatter.GetDefineSlotComment	(	string	source,
		string	lineNumber
	)

Gets the formatted comment for a define-slot attribute.

Returns

The formatted comment.

Parameters

source	The source information for the file.
lineNumber	The line number within the file.

Implemented in CSF.Zpt.SourceAnnotation.CommentFormatter.

string CSF.Zpt.SourceAnnotation.ICommentFormatter.GetImportedElementComment	(	string	source,
		string	lineNumber
	)

Gets the formatted comment for an imported element.

Returns

The formatted comment.

Parameters

source	The source information for the file.
lineNumber	The line number within the file.

Implemented in CSF.Zpt.SourceAnnotation.CommentFormatter.

string CSF.Zpt.SourceAnnotation.ICommentFormatter.GetRootElementComment	(	string	source,
		string	lineNumber
	)

Gets the formatted comment for the root element of a ZPT document.

Returns

The formatted comment.

Parameters

source	The source information for the file.
lineNumber	The line number within the file.

Implemented in CSF.Zpt.SourceAnnotation.CommentFormatter.

---

The documentation for this interface was generated from the following file:

• /home/craig/Projects/CSF.Zpt/CSF.Zpt.Abstractions/SourceAnnotation/ICommentFormatter.cs