Interface IDocumentation
Interface that determines if a model has code level documentation.
Namespace: CodeFactory.WinVs.Models.CSharp
Assembly: CodeFactory.WinVs.dll
Syntax
public interface IDocumentationProperties
Documentation
Documentation that has been assigned to this model.
Declaration
string Documentation { get; }Property Value
| Type | Description |
|---|---|
| string |
HasDocumentation
Flag that determines if the model has code level documentation assigned to it.
Declaration
bool HasDocumentation { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
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. |
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. |
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. |
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. |