Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to source code #46

Merged
merged 4 commits into from
Dec 10, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/CleanupDirPipe{I}.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Summary.Pipes.IO.CleanupDirPipe<I>
# [Summary.Pipes.IO.CleanupDirPipe<I>](../src/Core/Pipes/IO/CleanupDirPipe.cs#L6)
```cs
public class CleanupDirPipe<I> : IPipe<I, I>
```

Cleans up a given directory by deleting and re-creating it.

## Methods
### Run(I)
### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L8)
```cs
public Task<I> Run(I input)
```
Expand Down
18 changes: 9 additions & 9 deletions docs/ConsoleLoggerFactory.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Summary.Cli.Logging.ConsoleLoggerFactory
# [Summary.Cli.Logging.ConsoleLoggerFactory](../src/Cli/Logging/ConsoleLoggerFactory.cs#L9)
```cs
public class ConsoleLoggerFactory : ILoggerFactory
```

A simple factory for console loggers that format messages in the Summary CLI way.

## Fields
### Instance
### [Instance](../src/Cli/Logging/ConsoleLoggerFactory.cs#L37)
```cs
public static readonly ILogger Instance
```

## Methods
### Dispose()
### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L27)
```cs
public void Dispose()
```

### Log<TState>(LogLevel, EventId, TState, Exception?<Exception>, Func<TState, Exception?<Exception>, string>)
### [Log<TState>(LogLevel, EventId, TState, Exception?<Exception>, Func<TState, Exception?<Exception>, string>)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L41)
```cs
public void Log<TState>(
LogLevel logLevel,
Expand All @@ -27,27 +27,27 @@ public void Log<TState>(
Func<TState, Exception?, string> formatter)
```

### IsEnabled(LogLevel)
### [IsEnabled(LogLevel)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L49)
```cs
public bool IsEnabled(LogLevel logLevel)
```

### BeginScope<TState>(TState)
### [BeginScope<TState>(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L51)
```cs
public IDisposable? BeginScope<TState>(TState state)
```

### CreateLogger(string)
### [CreateLogger(string)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L63)
```cs
public ILogger CreateLogger(string categoryName)
```

### AddProvider(ILoggerProvider)
### [AddProvider(ILoggerProvider)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L65)
```cs
public void AddProvider(ILoggerProvider provider)
```

### Dispose()
### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L69)
```cs
public void Dispose()
```
Expand Down
10 changes: 5 additions & 5 deletions docs/Doc.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Summary.Doc
# [Summary.Doc](../src/Core/Doc.cs#L7)
```cs
public record Doc(DocMember[] Members)
```

A document parsed from the source code or an assembly.

## Fields
### Empty
### [Empty](../src/Core/Doc.cs#L12)
```cs
public static readonly Doc Empty
```

An empty document.

## Properties
### Members
### [Members](../src/Core/Doc.cs#L7)
```cs
public DocMember[] Members { get; }
```

The sequence of members this doc contains.

## Methods
### Merge(Doc, Doc)
### [Merge(Doc, Doc)](../src/Core/Doc.cs#L19)
```cs
public static Doc Merge(Doc a, Doc b)
```
Expand All @@ -33,7 +33,7 @@ Merges two documents together returning the new merged document.
- `a`: The first document to merge.
- `b`: The second document to merge.

### Declaration(DocType?<DocType>)
### [Declaration(DocType?<DocType>)](../src/Core/Doc.cs#L24)
```cs
public DocTypeDeclaration? Declaration(DocType? type)
```
Expand Down
16 changes: 8 additions & 8 deletions docs/DocComment.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Summary.DocComment
# [Summary.DocComment](../src/Core/DocComment.cs#L7)
```cs
public record DocComment(DocCommentNode[] Nodes)
```

A documentation comment parsed from the source code.

## Fields
### Empty
### [Empty](../src/Core/DocComment.cs#L12)
```cs
public static readonly DocComment Empty
```

An empty documentation comment.

## Properties
### Nodes
### [Nodes](../src/Core/DocComment.cs#L7)
```cs
public DocCommentNode[] Nodes { get; }
```

The sequence of nodes this comment consists of (e.g. `summary`, `remarks`, etc.).

## Methods
### Param(string)
### [Param(string)](../src/Core/DocComment.cs#L18)
```cs
public DocCommentElement? Param(string name)
```
Expand All @@ -32,7 +32,7 @@ A nested <param>documentation element that has the specified name.
#### Parameters
- `name`: The name of the parameter to search inside the comment.

### TypeParam(string)
### [TypeParam(string)](../src/Core/DocComment.cs#L25)
```cs
public DocCommentElement? TypeParam(string name)
```
Expand All @@ -42,7 +42,7 @@ A nested <typeparam>documentation element that has the specified name.
#### Parameters
- `name`: The name of the parameter to search inside the comment.

### Element(string, string)
### [Element(string, string)](../src/Core/DocComment.cs#L33)
```cs
public DocCommentElement? Element(string tag, string name)
```
Expand All @@ -53,7 +53,7 @@ A nested documentation element that has the specified name (e.g. `summary`, `rem
- `tag`: The name of the element tag to search inside the comment.
- `name`: The value of the `name` attribute of the tag.

### Element(string)
### [Element(string)](../src/Core/DocComment.cs#L40)
```cs
public DocCommentElement? Element(string tag)
```
Expand All @@ -63,7 +63,7 @@ A nested documentation element that has the specified name (e.g. `summary`, `rem
#### Parameters
- `tag`: The name of the element tag to search inside the comment.

### Element(Func<DocCommentElement, bool>)
### [Element(Func<DocCommentElement, bool>)](../src/Core/DocComment.cs#L47)
```cs
public DocCommentElement? Element(Func<DocCommentElement, bool> p)
```
Expand Down
8 changes: 4 additions & 4 deletions docs/DocCommentElement.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Summary.DocCommentElement
# [Summary.DocCommentElement](../src/Core/DocCommentElement.cs#L11)
```cs
public record DocCommentElement(string Name, DocCommentElementAttribute[] Attributes, DocCommentNode[] Nodes) : DocCommentNode
```
Expand All @@ -8,19 +8,19 @@ A [`DocCommentNode`](./DocCommentNode.md) that represents a compound element (e.
_Each element can contain simple text as well as other elements._

## Properties
### Name
### [Name](../src/Core/DocCommentElement.cs#L11)
```cs
public string Name { get; }
```

The name of the element (e.g. `remarks`, `summary`, `example`).

### Attributes
### [Attributes](../src/Core/DocCommentElement.cs#L11)
```cs
public DocCommentElementAttribute[] Attributes { get; }
```

### Nodes
### [Nodes](../src/Core/DocCommentElement.cs#L11)
```cs
public DocCommentNode[] Nodes { get; }
```
Expand Down
6 changes: 3 additions & 3 deletions docs/DocCommentElementAttribute.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Summary.DocCommentElementAttribute
# [Summary.DocCommentElementAttribute](../src/Core/DocCommentElementAttribute.cs#L8)
```cs
public record DocCommentElementAttribute(string Name, string Value)
```

An XML-documentation attribute (e.g. `name` in `param`, etc.).

## Properties
### Name
### [Name](../src/Core/DocCommentElementAttribute.cs#L8)
```cs
public string Name { get; }
```

The name of the attribute (e.g. `name`, `cref`, etc.)

### Value
### [Value](../src/Core/DocCommentElementAttribute.cs#L8)
```cs
public string Value { get; }
```
Expand Down
4 changes: 2 additions & 2 deletions docs/DocCommentInheritDoc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Summary.DocCommentInheritDoc
# [Summary.DocCommentInheritDoc](../src/Core/DocCommentInheritDoc.cs#L8)
```cs
public record DocCommentInheritDoc(string? Cref) : DocCommentNode
```
Expand All @@ -7,7 +7,7 @@ A [`DocCommentNode`](./DocCommentNode.md) that inherits documentation from anoth
(`<inheritdoc>`).

## Properties
### Cref
### [Cref](../src/Core/DocCommentInheritDoc.cs#L8)
```cs
public string? Cref { get; }
```
Expand Down
4 changes: 2 additions & 2 deletions docs/DocCommentLink.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Summary.DocCommentLink
# [Summary.DocCommentLink](../src/Core/DocCommentLink.cs#L8)
```cs
public record DocCommentLink(string Value) : DocCommentNode
```

A [`DocCommentNode`](./DocCommentNode.md) that represents the link to other member (e.g. `<see cref="SomeMember"/>`).

## Properties
### Value
### [Value](../src/Core/DocCommentLink.cs#L8)
```cs
public string Value { get; }
```
Expand Down
8 changes: 4 additions & 4 deletions docs/DocCommentLiteral.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Summary.DocCommentLiteral
# [Summary.DocCommentLiteral](../src/Core/DocCommentLiteral.cs#L15)
```cs
public record DocCommentLiteral(string Value, string LeadingTrivia = "") : DocCommentNode
```
Expand All @@ -8,22 +8,22 @@ A [`DocCommentNode`](./DocCommentNode.md) that represents a literal value (e.g.
_Literals are simple tokens that are parsed as text._

## Properties
### Value
### [Value](../src/Core/DocCommentLiteral.cs#L15)
```cs
public string Value { get; }
```

The value of the literal.

### LeadingTrivia
### [LeadingTrivia](../src/Core/DocCommentLiteral.cs#L15)
```cs
public string LeadingTrivia { get; }
```

The leading trivia of the literal that is not included in the `Value`(i.e. space characters, newlines).

## Methods
### New(string)
### [New(string)](../src/Core/DocCommentLiteral.cs#L20)
```cs
public static DocCommentLiteral New(string value)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/DocCommentNode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Summary.DocCommentNode
# [Summary.DocCommentNode](../src/Core/DocCommentNode.cs#L9)
```cs
public abstract record DocCommentNode
```
Expand Down
4 changes: 2 additions & 2 deletions docs/DocCommentParamRef.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Summary.DocCommentParamRef
# [Summary.DocCommentParamRef](../src/Core/DocCommentParamRef.cs#L7)
```cs
public record DocCommentParamRef(string Value) : DocCommentNode
```

A [`DocCommentNode`](./DocCommentNode.md) that represents the reference to a parameter (`<paramref>`, `<typeparamref>`).

## Properties
### Value
### [Value](../src/Core/DocCommentParamRef.cs#L7)
```cs
public string Value { get; }
```
Expand Down
6 changes: 3 additions & 3 deletions docs/DocDeprecation.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Summary.DocDeprecation
# [Summary.DocDeprecation](../src/Core/DocDeprecation.cs#L6)
```cs
public record DocDeprecation
```

Contains deprecation information (e.g. the warning message).

## Properties
### Message
### [Message](../src/Core/DocDeprecation.cs#L11)
```cs
public string? Message { get; init; }
```

The deprecation warning message.

### Error
### [Error](../src/Core/DocDeprecation.cs#L16)
```cs
public bool Error { get; init; }
```
Expand Down
6 changes: 3 additions & 3 deletions docs/DocExtensions.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Summary.DocExtensions
# [Summary.DocExtensions](../src/Core/DocExtensions.cs#L8)
```cs
public static class DocExtensions
```

Extension methods for different documentation model related types.

## Methods
### IsSpace(DocCommentNode)
### [IsSpace(DocCommentNode)](../src/Core/DocExtensions.cs#L13)
```cs
public static bool IsSpace(this DocCommentNode self)
```

Whether the given documentation comment node represents a space character.

### IsNewLine(DocCommentNode)
### [IsNewLine(DocCommentNode)](../src/Core/DocExtensions.cs#L19)
```cs
public static bool IsNewLine(this DocCommentNode self)
```
Expand Down
4 changes: 2 additions & 2 deletions docs/DocField.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Summary.DocField
# [Summary.DocField](../src/Core/DocField.cs#L6)
```cs
public record DocField : DocMember
```

A [`DocMember`](./DocMember.md) that represents a documented field in the parsed source code.

## Properties
### Type
### [Type](../src/Core/DocField.cs#L11)
```cs
public required DocType Type { get; init; }
```
Expand Down
4 changes: 2 additions & 2 deletions docs/DocIndexer.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Summary.DocIndexer
# [Summary.DocIndexer](../src/Core/DocIndexer.cs#L6)
```cs
public record DocIndexer : DocProperty
```

A [`DocProperty`](./DocProperty.md) that represents an indexer.

## Properties
### Params
### [Params](../src/Core/DocIndexer.cs#L11)
```cs
public required DocParam[] Params { get; init; }
```
Expand Down
Loading
Loading