Interface IDocumentation

Interface that determines if a model has code level documentation.

Namespace: CodeFactory.DotNet
Assembly: CodeFactory.DotNet.dll
Syntax
public interface IDocumentation

Properties

| Improve this Doc View Source

Documentation

Documentation that has been assigned to this model.

Declaration
string Documentation { get; }
Property Value
Type Description
string
| Improve this Doc View Source

HasDocumentation

Flag that determines if the model has code level documentation assigned to it.

Declaration
bool HasDocumentation { get; }
Property Value
Type Description
bool

Methods

| Improve this Doc View Source

AddAfterDocsAsync(string)

Adds the supplied source code directly after the documentation.

Declaration
Task<CsSource> AddAfterDocsAsync(string sourceCode)
Parameters
Type Name Description
string sourceCode

The target syntax to be added to the document.
Returns
Type Description
Task<CsSource>

Updated CsSource model with the injected source code.
| Improve this Doc View Source

AddBeforeDocsAsync(string)

Adds the supplied source code directly before the documentation.

Declaration
Task<CsSource> AddBeforeDocsAsync(string sourceCode)
Parameters
Type Name Description
string sourceCode

The target syntax to be added to the document.
Returns
Type Description
Task<CsSource>

Updated CsSource model with the injected source code.
| Improve this Doc View Source

DeleteDocsAsync()

Deletes the documentation from the target supporting code artifact.

Declaration
Task<CsSource> DeleteDocsAsync()
Returns
Type Description
Task<CsSource>

Updated CsSource model with the documentation removed.
| Improve this Doc View Source

ReplaceDocsAsync(string)

Replaces the supplied source code directly this the documentation.

Declaration
Task<CsSource> ReplaceDocsAsync(string sourceCode)
Parameters
Type Name Description
string sourceCode

The target syntax to be added to the document.
Returns
Type Description
Task<CsSource>

Updated CsSource model with the injected source code.

Extension Methods

DocumentationExtensions.CSharpFormatXmlDocumentationEnumerator(IDocumentation)