diff options
| author | Joel Martinez <joelmartinez@gmail.com> | 2015-03-18 23:32:14 +0300 |
|---|---|---|
| committer | Joel Martinez <joelmartinez@gmail.com> | 2015-03-19 17:41:50 +0300 |
| commit | 6a35acd4e16a41b6d8b0fb9e6eb2bb8ac1f8689e (patch) | |
| tree | 56b67bec4cbf51b34b19130b9015d9c1d903a6ff /mcs/class/monodoc | |
| parent | 1e45f99905312fb6a8a27aed7ff28524b6183cf6 (diff) | |
[monodoc] Added `PlatformDocApi` to the list of valid related sections.
The use case here is when you are documenting a managed wrapper on top of a native platform API. This related link can be used to link to the original platform documentation for that member. This lets the reader look up the semantics of the native call without you having to duplicate the documentation in the managed reference docs; leaving you to focus your energies on documenting any unique considerations when calling this managed API.
Example:
```xml
<related type="PlatformDocAPI" href="https://msdn.microsoft.com/en-us/library/system.console.writeline">Microsoft documentation for <c>System.Console.WriteLine</c></related>
```
Diffstat (limited to 'mcs/class/monodoc')
| -rw-r--r-- | mcs/class/monodoc/Resources/mdoc-html-utils.xsl | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/mcs/class/monodoc/Resources/mdoc-html-utils.xsl b/mcs/class/monodoc/Resources/mdoc-html-utils.xsl index 2c340f75074..43983af55cf 100644 --- a/mcs/class/monodoc/Resources/mdoc-html-utils.xsl +++ b/mcs/class/monodoc/Resources/mdoc-html-utils.xsl @@ -840,6 +840,10 @@ <xsl:with-param name="content"> <div class="related"> <xsl:call-template name="CreateRelatedSection"> + <xsl:with-param name="section" select="'Platform Docs'" /> + <xsl:with-param name="type" select="'PlatformDocAPI'" /> + </xsl:call-template> + <xsl:call-template name="CreateRelatedSection"> <xsl:with-param name="section" select="'Articles'" /> <xsl:with-param name="type" select="'article'" /> </xsl:call-template> |