Optionally, fetch source code information from a definitive source

VersionHistory.md

@@ -1,5 +1,8 @@
 # Version History
 
+### 2.x.x 
+* Add `--source-style` to extend the generation of source URLs for the `--source` option
+
 ### 2.1.0
 
 * Add `--skip-unbrowsable`, `--namespace-pages`, `--front-matter`, `--permalink`, `--toc`, and `--toc-prefix`.

docs/XmlDocMarkdown.Core.md

@@ -8,6 +8,7 @@
 | static class [XmlDocMarkdownGenerator](XmlDocMarkdown.Core/XmlDocMarkdownGenerator.md) | Generates Markdown from .NET XML documentation comments. |
 | class [XmlDocMarkdownResult](XmlDocMarkdown.Core/XmlDocMarkdownResult.md) | The names of files that were added, changed, or removed. |
 | class [XmlDocMarkdownSettings](XmlDocMarkdown.Core/XmlDocMarkdownSettings.md) | Settings for markdown generation. |
+| [Flags] enum [XmlDocSourceCodeStyle](XmlDocMarkdown.Core/XmlDocSourceCodeStyle.md) | The approach used for documenting source code paths, if `--source` is given. |
 | enum [XmlDocVisibilityLevel](XmlDocMarkdown.Core/XmlDocVisibilityLevel.md) | The minimum visibility for documented types and members. |
 
 <!-- DO NOT EDIT: generated by xmldocmd for XmlDocMarkdown.Core.dll -->

docs/XmlDocMarkdown.Core/XmlDocMarkdownSettings.md

@@ -24,6 +24,7 @@ public class XmlDocMarkdownSettings
 | [ShouldClean](XmlDocMarkdownSettings/ShouldClean.md) { get; set; } | If true, deletes previously generated files that are no longer used. |
 | [SkipUnbrowsable](XmlDocMarkdownSettings/SkipUnbrowsable.md) { get; set; } | If true, skips documentation for types and members with `[EditorBrowsable(EditorBrowsableState.Never)]`. |
 | [SourceCodePath](XmlDocMarkdownSettings/SourceCodePath.md) { get; set; } | The URL of the folder containing the source code of the assembly, e.g. at GitHub. |
+| [SourceCodeStyle](XmlDocMarkdownSettings/SourceCodeStyle.md) { get; set; } | The manner in which the URL path is derived, |
 | [TocPrefix](XmlDocMarkdownSettings/TocPrefix.md) { get; set; } | A path prefix to add to all links in the table of contents .yml file. |
 | [VisibilityLevel](XmlDocMarkdownSettings/VisibilityLevel.md) { get; set; } | The minimum visibility for documented types and members. |
 

docs/XmlDocMarkdown.Core/XmlDocMarkdownSettings/SourceCodeStyle.md

@@ -0,0 +1,19 @@
+# XmlDocMarkdownSettings.SourceCodeStyle property
+
+The manner in which the URL path is derived,
+
+```csharp
+public XmlDocSourceCodeStyle? SourceCodeStyle { get; set; }
+```
+
+## Remarks
+
+May be a combination of flags, with the preference order being SourceLink, DebugSymbol and finally TypeName
+
+## See Also
+
+* enum [XmlDocSourceCodeStyle](../XmlDocSourceCodeStyle.md)
+* class [XmlDocMarkdownSettings](../XmlDocMarkdownSettings.md)
+* namespace [XmlDocMarkdown.Core](../../XmlDocMarkdown.Core.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for XmlDocMarkdown.Core.dll -->

docs/XmlDocMarkdown.Core/XmlDocSourceCodeStyle.md

@@ -0,0 +1,24 @@
+# XmlDocSourceCodeStyle enumeration
+
+The approach used for documenting source code paths, if `--source` is given.
+
+```csharp
+[Flags]
+public enum XmlDocSourceCodeStyle
+```
+
+## Values
+
+| name | value | description |
+| --- | --- | --- |
+| Default | `0x0` | Path is based on type name, and C# is assumed. |
+| TypeName | `0x1` | If no other path is found, report based on type name, and C# is assumed. |
+| DebugSymbol | `0x2` | If debug symbol information is found, report based on the document(s) in which the type has members. |
+| SourceLink | `0x4` | If debug symbol information is found, and sourcelink information is present, use that to report based on the document(s) in which the type has members, in preference to all else. |
+
+## See Also
+
+* namespace [XmlDocMarkdown.Core](../XmlDocMarkdown.Core.md)
+* [XmlDocSourceCodeStyle.cs](../../src/XmlDocMarkdown.Core/XmlDocSourceCodeStyle.cs)
+
+<!-- DO NOT EDIT: generated by xmldocmd for XmlDocMarkdown.Core.dll -->