-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(apireference): Add support for nested types
Add support for nested types to generation of API reference. Nested types will show up in the list of types and get a documentation page just like top-level types. A list of nested types is included in documentation page of the surrounding type. See PR #6
- Loading branch information
Showing
47 changed files
with
2,119 additions
and
314 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
...demoprojects/api/DemoProject/NestedTypesDemo/NestedClass1/constructors/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# NestedTypesDemo.NestedClass1 Constructors | ||
|
||
**Declaring Type:** [NestedTypesDemo.NestedClass1](../index.md) | ||
|
||
```csharp | ||
public NestedClass1(); | ||
``` | ||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
25 changes: 25 additions & 0 deletions
25
docs/demoprojects/api/DemoProject/NestedTypesDemo/NestedClass1/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# NestedTypesDemo.NestedClass1 Class | ||
|
||
**Declaring Type:** [NestedTypesDemo](../index.md) | ||
|
||
**Namespace:** [DemoProject](../../index.md) | ||
|
||
**Assembly:** DemoProject | ||
|
||
This is an example of a nested class | ||
|
||
```csharp | ||
public class NestedTypesDemo.NestedClass1 | ||
``` | ||
|
||
**Inheritance:** object → NestedTypesDemo.NestedClass1 | ||
|
||
## Constructors | ||
|
||
| Name | Description | | ||
| --------------------------------------- | ----------- | | ||
| [NestedClass1()](constructors/index.md) | | | ||
|
||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
10 changes: 10 additions & 0 deletions
10
...api/DemoProject/NestedTypesDemo/NestedClass2/NestedClass3/constructors/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# NestedTypesDemo.NestedClass2.NestedClass3 Constructors | ||
|
||
**Declaring Type:** [NestedTypesDemo.NestedClass2.NestedClass3](../index.md) | ||
|
||
```csharp | ||
public NestedClass3(); | ||
``` | ||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
25 changes: 25 additions & 0 deletions
25
...demoprojects/api/DemoProject/NestedTypesDemo/NestedClass2/NestedClass3/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# NestedTypesDemo.NestedClass2.NestedClass3 Class | ||
|
||
**Declaring Type:** [NestedTypesDemo.NestedClass2](../index.md) | ||
|
||
**Namespace:** [DemoProject](../../../index.md) | ||
|
||
**Assembly:** DemoProject | ||
|
||
This is an example of an nested class within a nested class | ||
|
||
```csharp | ||
public class NestedTypesDemo.NestedClass2.NestedClass3 | ||
``` | ||
|
||
**Inheritance:** object → NestedTypesDemo.NestedClass2.NestedClass3 | ||
|
||
## Constructors | ||
|
||
| Name | Description | | ||
| --------------------------------------- | ----------- | | ||
| [NestedClass3()](constructors/index.md) | | | ||
|
||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
10 changes: 10 additions & 0 deletions
10
...demoprojects/api/DemoProject/NestedTypesDemo/NestedClass2/constructors/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# NestedTypesDemo.NestedClass2 Constructors | ||
|
||
**Declaring Type:** [NestedTypesDemo.NestedClass2](../index.md) | ||
|
||
```csharp | ||
public NestedClass2(); | ||
``` | ||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
31 changes: 31 additions & 0 deletions
31
docs/demoprojects/api/DemoProject/NestedTypesDemo/NestedClass2/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# NestedTypesDemo.NestedClass2 Class | ||
|
||
**Declaring Type:** [NestedTypesDemo](../index.md) | ||
|
||
**Namespace:** [DemoProject](../../index.md) | ||
|
||
**Assembly:** DemoProject | ||
|
||
This is an example of a nested class that in turn contains nested types | ||
|
||
```csharp | ||
public class NestedTypesDemo.NestedClass2 | ||
``` | ||
|
||
**Inheritance:** object → NestedTypesDemo.NestedClass2 | ||
|
||
## Constructors | ||
|
||
| Name | Description | | ||
| --------------------------------------- | ----------- | | ||
| [NestedClass2()](constructors/index.md) | | | ||
|
||
## Nested Types | ||
|
||
| Name | Description | | ||
| ------------------------------------------------------------------ | ----------------------------------------------------------- | | ||
| [NestedTypesDemo.NestedClass2.NestedClass3](NestedClass3/index.md) | This is an example of an nested class within a nested class | | ||
|
||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
16 changes: 16 additions & 0 deletions
16
docs/demoprojects/api/DemoProject/NestedTypesDemo/NestedInterface1/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# NestedTypesDemo.NestedInterface1 Interface | ||
|
||
**Declaring Type:** [NestedTypesDemo](../index.md) | ||
|
||
**Namespace:** [DemoProject](../../index.md) | ||
|
||
**Assembly:** DemoProject | ||
|
||
This is an example of a nested interface | ||
|
||
```csharp | ||
public interface NestedTypesDemo.NestedInterface1 | ||
``` | ||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
10 changes: 10 additions & 0 deletions
10
docs/demoprojects/api/DemoProject/NestedTypesDemo/constructors/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# NestedTypesDemo Constructors | ||
|
||
**Declaring Type:** [NestedTypesDemo](../index.md) | ||
|
||
```csharp | ||
public NestedTypesDemo(); | ||
``` | ||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
31 changes: 31 additions & 0 deletions
31
docs/demoprojects/api/DemoProject/NestedTypesDemo/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# NestedTypesDemo Class | ||
|
||
**Namespace:** [DemoProject](../index.md) | ||
|
||
**Assembly:** DemoProject | ||
|
||
This class shows an example of how the documentation for nested types looks. | ||
|
||
```csharp | ||
public class NestedTypesDemo | ||
``` | ||
|
||
**Inheritance:** object → NestedTypesDemo | ||
|
||
## Constructors | ||
|
||
| Name | Description | | ||
| ------------------------------------------ | ----------- | | ||
| [NestedTypesDemo()](constructors/index.md) | | | ||
|
||
## Nested Types | ||
|
||
| Name | Description | | ||
| ------------------------------------------------------------- | ----------------------------------------------------------------------- | | ||
| [NestedTypesDemo.NestedClass1](NestedClass1/index.md) | This is an example of a nested class | | ||
| [NestedTypesDemo.NestedClass2](NestedClass2/index.md) | This is an example of a nested class that in turn contains nested types | | ||
| [NestedTypesDemo.NestedInterface1](NestedInterface1/index.md) | This is an example of a nested interface | | ||
|
||
___ | ||
|
||
*Documentation generated by [MdDocs](https://github.com/ap0llo/mddocs)* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
namespace DemoProject | ||
{ | ||
/// <summary> | ||
/// This class shows an example of how the documentation for nested types looks. | ||
/// </summary> | ||
public class NestedTypesDemo | ||
{ | ||
/// <summary> | ||
/// This is an example of a nested class | ||
/// </summary> | ||
public class NestedClass1 | ||
{ } | ||
|
||
/// <summary> | ||
/// This is an example of a nested class that in turn contains nested types | ||
/// </summary> | ||
public class NestedClass2 | ||
{ | ||
/// <summary> | ||
/// This is an example of an nested class within a nested class | ||
/// </summary> | ||
public class NestedClass3 | ||
{ } | ||
} | ||
|
||
/// <summary> | ||
/// This is an example of a nested interface | ||
/// </summary> | ||
public interface NestedInterface1 | ||
{ } | ||
} | ||
} |
Oops, something went wrong.