documentation cleanup

Doraku · Oct 23, 2024 · fb67f6b · fb67f6b
1 parent 22e4484
commit fb67f6b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,7 @@ dotnet tool
   - [TableOfContentsModes](#MarkdownConfiguration_TableOfContentsModes)
   - [Url format](#MarkdownConfiguration_UrlFormat)
   - [Exclude](#MarkdownConfiguration_Exclude)
+  - [UseFullUrl](#MarkdownConfiguration_UseFullUrl)
 - [Samples](#Samples)
 - [Dependencies](#Dependencies)
 
@@ -574,6 +575,14 @@ any `DocItem` whose id will match one of them will be excluded from the document
 
 The default value is `null`.
 
+<a name='MarkdownConfiguration_UseFullUrl'></a>
+## UseFullUrl
+- configuration file: `"Markdown.UseFullUrl": bool`
+
+States if the url written should be absolute if a [LinksBaseUrl](#Configuration_LinksBaseUrl) is provided.
+
+The default value is `false`.
+
 <a name='Samples'></a>
 # Samples
 - [DefaultDocumentation api](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/index.md)

diff --git a/source/DefaultDocumentation.Markdown/Extensions/IGeneralContextExtensions.cs b/source/DefaultDocumentation.Markdown/Extensions/IGeneralContextExtensions.cs
@@ -18,7 +18,7 @@ public static class IGeneralContextExtensions
     private const string _useFullUrlKey = "Markdown.UseFullUrl";
 
     /// <summary>
-    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities">Markdown.NestedTypeVisibilities</see> setting.
+    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_NestedTypeVisibilities">Markdown.NestedTypeVisibilities</see> setting.
     /// </summary>
     /// <param name="context">The <see cref="IGeneralContext"/> of the current documentation file.</param>
     /// <param name="type">The <see cref="Type"/> for which to get the setting.</param>
@@ -39,7 +39,7 @@ public static NestedTypeVisibilities GetNestedTypeVisibilities(this IGeneralCont
     }
 
     /// <summary>
-    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl">Markdown.RemoveFileExtensionFromUrl</see> setting.
+    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_RemoveFileExtensionFromUrl">Markdown.RemoveFileExtensionFromUrl</see> setting.
     /// </summary>
     /// <param name="context">The <see cref="IGeneralContext"/> of the current documentation file.</param>
     /// <returns>Whether to include the file extension in urls.</returns>
@@ -51,7 +51,7 @@ public static bool GetRemoveFileExtensionFromUrl(this IGeneralContext context)
     }
 
     /// <summary>
-    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement">Markdown.InvalidCharReplacement</see> setting.
+    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_InvalidCharReplacement">Markdown.InvalidCharReplacement</see> setting.
     /// </summary>
     /// <param name="context">The <see cref="IGeneralContext"/> of the current documentation file.</param>
     /// <returns>The <see cref="string"/> to use to replace invalid chars in generated file name.</returns>
@@ -63,10 +63,9 @@ public static bool GetRemoveFileExtensionFromUrl(this IGeneralContext context)
     }
 
     /// <summary>
-    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#usefullurl">Markdown.UseFullUrl</see> setting.
+    /// Gets the <see href="https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UseFullUrl">Markdown.UseFullUrl</see> setting.
     /// </summary>
     /// <param name="context">The <see cref="IGeneralContext"/> of the current documentation file.</param>
-    /// <returns>The <see cref="string"/> to use to replace invalid chars in generated file name.</returns>
     public static bool GetUseFullUrl(this IGeneralContext context)
     {
         context.ThrowIfNull();