Skip to content

Commit

Permalink
#201 - Update source wiki with table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
hailstorm75 committed Mar 8, 2022
1 parent e72006c commit 92d8751
Show file tree
Hide file tree
Showing 8 changed files with 319 additions and 7 deletions.
260 changes: 260 additions & 0 deletions sourceWiki/Table of Contents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,260 @@
# Table of contents

- MarkDoc
- [
*IDocMember*
](./markdoc/documentation/IDocMember.md)
- [
*MemberType*
](./markdoc/documentation/idocmember/MemberType.md)
- [
*IDocResolver*
](./markdoc/documentation/IDocResolver.md)
- [
*IDocSettings*
](./markdoc/documentation/IDocSettings.md)
- [
*IDocElement*
](./markdoc/documentation/IDocElement.md)
- [
*IDocumentation*
](./markdoc/documentation/IDocumentation.md)
- Documentation
- [
*IContent*
](./markdoc/documentation/tags/IContent.md)
- [
*IInnerTag*
](./markdoc/documentation/tags/IInnerTag.md)
- [
*InnerTagType*
](./markdoc/documentation/tags/iinnertag/InnerTagType.md)
- [
*IListTag*
](./markdoc/documentation/tags/IListTag.md)
- [
*ListType*
](./markdoc/documentation/tags/ilisttag/ListType.md)
- [
*ITag*
](./markdoc/documentation/tags/ITag.md)
- [
*TagType*
](./markdoc/documentation/tags/itag/TagType.md)
- [
*ITextTag*
](./markdoc/documentation/tags/ITextTag.md)
- Tags
- [
*IDefiniteProcess*
](./markdoc/core/IDefiniteProcess.md)
- [
*IDialogView*
](./markdoc/core/IDialogView.md)
- [
*IDialogView*
](./markdoc/core/IDialogViewT.md)
- [
*IDialogViewModel*
](./markdoc/core/IDialogViewModel.md)
- [
*IGlobalSettings*
](./markdoc/core/IGlobalSettings.md)
- [
*IIndefiniteProcess*
](./markdoc/core/IIndefiniteProcess.md)
- [
*ILibrarySettings*
](./markdoc/core/ILibrarySettings.md)
- [
*IMarkDocLogger*
](./markdoc/core/IMarkDocLogger.md)
- [
*LogType*
](./markdoc/core/imarkdoclogger/LogType.md)
- [
*IPlugin*
](./markdoc/core/IPlugin.md)
- [
*IPluginStep*
](./markdoc/core/IPluginStep.md)
- [
*IProcess*
](./markdoc/core/IProcess.md)
- [
*ProcessState*
](./markdoc/core/iprocess/ProcessState.md)
- [
*ISettingsCreator*
](./markdoc/core/ISettingsCreator.md)
- [
*IStepView*
](./markdoc/core/IStepViewTT.md)
- [
*IStepView*
](./markdoc/core/IStepViewT.md)
- [
*IStepViewModel*
](./markdoc/core/IStepViewModelT.md)
- [
*IStepViewModel*
](./markdoc/core/IStepViewModel.md)
- [
*IView*
](./markdoc/core/IViewT.md)
- [
*IView*
](./markdoc/core/IView.md)
- [
*IViewModel*
](./markdoc/core/IViewModel.md)
- [
*LogMessage*
](./markdoc/core/LogMessage.md)
- Core
- [
*IMemberSettings*
](./markdoc/members/IMemberSettings.md)
- [
*IResolver*
](./markdoc/members/IResolver.md)
- Members
- [
*IClass*
](./markdoc/members/types/IClass.md)
- [
*IEnum*
](./markdoc/members/types/IEnum.md)
- [
*IInterface*
](./markdoc/members/types/IInterface.md)
- [
*IRecord*
](./markdoc/members/types/IRecord.md)
- [
*IStruct*
](./markdoc/members/types/IStruct.md)
- [
*IType*
](./markdoc/members/types/IType.md)
- Types
- [
*IResArray*
](./markdoc/members/resolvedtypes/IResArray.md)
- [
*IResGeneric*
](./markdoc/members/resolvedtypes/IResGeneric.md)
- [
*IResTuple*
](./markdoc/members/resolvedtypes/IResTuple.md)
- [
*IResType*
](./markdoc/members/resolvedtypes/IResType.md)
- ResolvedTypes
- [
*IArgument*
](./markdoc/members/members/IArgument.md)
- [
*IConstructor*
](./markdoc/members/members/IConstructor.md)
- [
*IDelegate*
](./markdoc/members/members/IDelegate.md)
- [
*IEnumField*
](./markdoc/members/members/IEnumField.md)
- [
*IEvent*
](./markdoc/members/members/IEvent.md)
- [
*IMember*
](./markdoc/members/members/IMember.md)
- [
*IMethod*
](./markdoc/members/members/IMethod.md)
- [
*IProperty*
](./markdoc/members/members/IProperty.md)
- Members
- [
*AccessorType*
](./markdoc/members/enums/AccessorType.md)
- [
*ArgumentType*
](./markdoc/members/enums/ArgumentType.md)
- [
*MemberInheritance*
](./markdoc/members/enums/MemberInheritance.md)
- [
*OperatorType*
](./markdoc/members/enums/OperatorType.md)
- [
*Variance*
](./markdoc/members/enums/Variance.md)
- Enums
- [
*IDiagram*
](./markdoc/elements/IDiagram.md)
- [
*IElement*
](./markdoc/elements/IElement.md)
- [
*IElementCreator*
](./markdoc/elements/IElementCreator.md)
- [
*ILink*
](./markdoc/elements/ILink.md)
- [
*IList*
](./markdoc/elements/IList.md)
- [
*ListType*
](./markdoc/elements/ilist/ListType.md)
- [
*IPage*
](./markdoc/elements/IPage.md)
- [
*ISection*
](./markdoc/elements/ISection.md)
- [
*ITable*
](./markdoc/elements/ITable.md)
- [
*IText*
](./markdoc/elements/IText.md)
- [
*TextStyle*
](./markdoc/elements/itext/TextStyle.md)
- [
*ITextBuilder*
](./markdoc/elements/ITextBuilder.md)
- [
*ITextContent*
](./markdoc/elements/ITextContent.md)
- Elements
- [
*IHasContent*
](./markdoc/elements/extensions/IHasContentT.md)
- [
*IHasHeading*
](./markdoc/elements/extensions/IHasHeading.md)
- Extensions
- [
*IPrinter*
](./markdoc/printer/IPrinter.md)
- Printer
- [
*IDiagramResolver*
](./markdoc/diagrams/IDiagramResolver.md)
- Diagrams
- [
*ITypeComposer*
](./markdoc/generator/ITypeComposer.md)
- Generator
- [
*ILinker*
](./markdoc/linkers/ILinker.md)
- [
*ILinkerSettings*
](./markdoc/linkers/ILinkerSettings.md)
- Linkers
2 changes: 1 addition & 1 deletion sourceWiki/markdoc/documentation/tags/IListTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public abstract IReadOnlyCollection Headings { get }
List headings

##### Remarks
Used when the list is a [ListType](ilisttag/ListType.md).[Table](markdoc/documentation/tags/IListTag.md#table)
Used when the list is a [ListType](ilisttag/ListType.md).Table

#### Rows
```csharp
Expand Down
17 changes: 14 additions & 3 deletions sourceWiki/markdoc/generator/ITypeComposer.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Interface for type printers
#### Public methods
| Returns | Name |
| --- | --- |
| [`IPage`](../elements/IPage.md) | [`Compose`](markdoc/generator/ITypeComposer.md#compose)([`IType`](../members/types/IType.md) type)<br>Prints a [IPage](../elements/IPage.md) from the provided `type` |
| [`IPage`](../elements/IPage.md) | [`Compose`](markdoc/generator/ITypeComposer.md#compose)([`IType`](../members/types/IType.md) type)<br>Composes a [IPage](../elements/IPage.md) from the provided `type` |
| [`IPage`](../elements/IPage.md) | [`ComposeTableOfContents`](markdoc/generator/ITypeComposer.md#composetableofcontents)()<br>Composes a [IPage](../elements/IPage.md) containing links to all types |

## Details
### Summary
Expand All @@ -36,9 +37,19 @@ public abstract IPage Compose(IType type)
| [`IType`](../members/types/IType.md) | type | Type to process |

##### Summary
Prints a [IPage](../elements/IPage.md) from the provided `type`
Composes a [IPage](../elements/IPage.md) from the provided `type`

##### Returns
Generated page
Composed page

#### ComposeTableOfContents
```csharp
public abstract IPage ComposeTableOfContents()
```
##### Summary
Composes a [IPage](../elements/IPage.md) containing links to all types

##### Returns
Composed page

*Generated with* [*MarkDoc*](https://github.com/hailstorm75/MarkDoc.Core)
21 changes: 18 additions & 3 deletions sourceWiki/markdoc/linkers/ILinker.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Interface for creating links
| Returns | Name |
| --- | --- |
| `Lazy` | [`CreateAnchor`](markdoc/linkers/ILinker.md#createanchor)([`IType`](../members/types/IType.md) page, [`IMember`](../members/members/IMember.md) member)<br>Creates an anchor to a given `member` |
| `string` | [`CreateLink`](markdoc/linkers/ILinker.md#createlink-12)(`...`)<br>Creates a link to a given type `target` |
| `string` | [`CreateLink`](markdoc/linkers/ILinker.md#createlink-13)(`...`)<br>Creates a link to a given type `target` |
| `string` | [`CreateLinkToSourceCode`](markdoc/linkers/ILinker.md#createlinktosourcecode)([`IMember`](../members/members/IMember.md) member) |
| `void` | [`RegisterAnchor`](markdoc/linkers/ILinker.md#registeranchor)([`IMember`](../members/members/IMember.md) member, `Lazy`&lt;`string`&gt; anchor) |

Expand All @@ -35,7 +35,22 @@ Interface for creating links
Interface for creating links

### Methods
#### CreateLink [1/2]
#### CreateLink [1/3]
```csharp
public abstract string CreateLink(IType target)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IType`](../members/types/IType.md) | target | Link target |

##### Summary
Creates a link to a given type `target`

##### Returns
Retrieved link

#### CreateLink [2/3]
```csharp
public abstract string CreateLink(IType source, IResType target)
```
Expand All @@ -51,7 +66,7 @@ Creates a link to a given type `target`
##### Returns
Retrieved link

#### CreateLink [2/2]
#### CreateLink [3/3]
```csharp
public abstract string CreateLink(IType source, IType target)
```
Expand Down
8 changes: 8 additions & 0 deletions sourceWiki/markdoc/members/IResolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Type resolver
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Lazy`&lt;`TrieNamespace`&gt; | [`Namespaces`](markdoc/members/IResolver.md#namespaces)<br>Resolved namespace trie | `get` |
| `Lazy`&lt;`IReadOnlyDictionary`&gt; | [`Types`](markdoc/members/IResolver.md#types)<br>Resolved types | `get` |

### Methods
Expand Down Expand Up @@ -92,4 +93,11 @@ public abstract Lazy Types { get }
##### Summary
Resolved types

#### Namespaces
```csharp
public abstract Lazy Namespaces { get }
```
##### Summary
Resolved namespace trie

*Generated with* [*MarkDoc*](https://github.com/hailstorm75/MarkDoc.Core)
6 changes: 6 additions & 0 deletions sourceWiki/markdoc/members/enums/OperatorType.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# OperatorType `enum`

## Description
Types of method operators

## Diagram
```mermaid
flowchart LR
Expand All @@ -11,6 +14,9 @@
```

## Details
### Summary
Types of method operators

### Fields
#### None

Expand Down
Loading

0 comments on commit 92d8751

Please sign in to comment.