nuget
APIExtensions
01 Syntax
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| TrimAssemblyDoc | 1 | Normalize the raw .net xml comment document into markdown text: 1. |
| transFence | 1 | the markdown fenced code block that is written by the author is a literal text too, so its inner xml document tags are also converted into the plain text. |
| codeSafe | 1 | the content of a code block is a literal text which is not parsed as markdown, so the inner xml document tags must be converted into the plain text instead of the markdown format… |
| CrefDisplayName | 1 | Build a human readable display text for a xml document cref identity, for example T:System.Console => Console, and M:Ns.ProjectSpace.Import(System.String) => ProjectSpace.Import… |
| StripArity | 1 | remove the generic arity suffix of a clr type name, for example List1 => List. |
| Sum | 2 | |
| Load | 1 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| Types | 1 |
04 Fields
| Name | Overloads | Summary |
|---|---|---|
| NamespaceDoc | 2 | NDoc supports this by recognising a special NamespaceDoc class located in each namespace > https://stackoverflow.com/questions/793210/xml-documentation-for-a-namespace 这个名字的对… |
| CrefUrlPrefix | 2 | the url protocol prefix of a cross reference link that is generated from the <see cref="..." /> / <seealso cref="..." /> xml document tags. |
| fenceTag | 1 | the markdown fenced code block that is written in the xml comment text. |
05 Members
String)Normalize the raw .net xml comment document into markdown text:
<code>/<c>into code block / inline code;<see cref="..." />/<seealso />into a markdown link that keeps the original cref identity (see cref link prefix);<paramref />/<typeparamref />into bold text;<list>/<para>/<br/>into the markdown equivalent.
| Name | Type | Description |
|---|---|---|
doc | String | - |
the markdown fenced code block that is written by the author is a literal text too, so its inner xml document tags are also converted into the plain text.
| Name | Type | Description |
|---|---|---|
m | Match | - |
String)the content of a code block is a literal text which is not parsed as markdown, so the inner xml document tags must be converted into the plain text instead of the markdown formatting.
| Name | Type | Description |
|---|---|---|
s | String | - |
String)Build a human readable display text for a xml document cref identity, for example T:System.Console => Console, and M:Ns.ProjectSpace.Import(System.String) => ProjectSpace.Import().
| Name | Type | Description |
|---|---|---|
cref | String | - |
String)remove the generic arity suffix of a clr type name, for example List`1 => List.
| Name | Type | Description |
|---|---|---|
name | String | - |
NDoc supports this by recognising a special NamespaceDoc class located in each namespace
https://stackoverflow.com/questions/793210/xml-documentation-for-a-namespace
这个名字的对象类型主要是被用来标记命名空间的注释信息使用的
the url protocol prefix of a cross reference link that is generated from the <see cref="..." /> / <seealso cref="..." /> xml document tags. the api document generator will resolve this prefix into the real target page url, and it will be rendered as a plain text when the target could not be resolved.
the markdown fenced code block that is written in the xml comment text. the body is not allowed to cross a xml element boundary (a line which starts with <), so this replace could never break the xml structure of the comment document.
IEnumerable(Of Project), String(), String)IEnumerable(Of ProjectMember), ProjectType)String)