doco

JayBazuzi · Dec 26, 2019 · 3206456 · 3206456
1 parent e21548b
commit 3206456
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 2 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -38,7 +38,7 @@ var snippetExtractor = new DirectorySnippetExtractor(
                                 !dirPath.EndsWith("obj"));
 var snippets = snippetExtractor.ReadSnippets(@"C:\path");
 ```
-<sup><a href='/src/Tests/Snippets/Usage.cs#L30-L39' title='File snippet `readingdirectorysimple` was extracted from'>snippet source</a> | <a href='#snippet-readingdirectorysimple' title='Navigate to start of snippet `readingdirectorysimple`'>anchor</a></sup>
+<sup><a href='/src/Tests/Snippets/Usage.cs#L40-L49' title='File snippet `readingdirectorysimple` was extracted from'>snippet source</a> | <a href='#snippet-readingdirectorysimple' title='Navigate to start of snippet `readingdirectorysimple`'>anchor</a></sup>
 <!-- endsnippet -->
 
 
@@ -77,7 +77,7 @@ var missingSnippets = result.MissingSnippets;
 // snippets that the markdown file used
 var usedSnippets = result.UsedSnippets;
 ```
-<sup><a href='/src/Tests/Snippets/Usage.cs#L44-L76' title='File snippet `markdownprocessingsimple` was extracted from'>snippet source</a> | <a href='#snippet-markdownprocessingsimple' title='Navigate to start of snippet `markdownprocessingsimple`'>anchor</a></sup>
+<sup><a href='/src/Tests/Snippets/Usage.cs#L54-L86' title='File snippet `markdownprocessingsimple` was extracted from'>snippet source</a> | <a href='#snippet-markdownprocessingsimple' title='Navigate to start of snippet `markdownprocessingsimple`'>anchor</a></sup>
 <!-- endsnippet -->
 
 

diff --git a/docs/max-width.md b/docs/max-width.md
@@ -19,6 +19,25 @@ The Max Width setting is used to control the maximum characters per line of a sn
 ```
 
 
+## Command Line
+
+```
+--max-width 80
+```
+
+
+## Code Api
+
+<!-- snippet: DirectoryMarkdownProcessorRunMaxWidth -->
+<a id='snippet-directorymarkdownprocessorrunmaxwidth'/></a>
+```cs
+var processor = new DirectoryMarkdownProcessor("targetDirectory", maxWidth: 80);
+processor.Run();
+```
+<sup><a href='/src/Tests/Snippets/Usage.cs#L30-L35' title='File snippet `directorymarkdownprocessorrunmaxwidth` was extracted from'>snippet source</a> | <a href='#snippet-directorymarkdownprocessorrunmaxwidth' title='Navigate to start of snippet `directorymarkdownprocessorrunmaxwidth`'>anchor</a></sup>
+<!-- endsnippet -->
+
+
 ## References
 
 https://en.wikipedia.org/wiki/Line_length#Electronic_text

diff --git a/docs/mdsource/max-width.source.md b/docs/mdsource/max-width.source.md
@@ -12,6 +12,18 @@ The Max Width setting is used to control the maximum characters per line of a sn
 ```
 
 
+## Command Line
+
+```
+--max-width 80
+```
+
+
+## Code Api
+
+snippet: DirectoryMarkdownProcessorRunMaxWidth
+
+
 ## References
 
 https://en.wikipedia.org/wiki/Line_length#Electronic_text

diff --git a/src/Tests/Snippets/Usage.cs b/src/Tests/Snippets/Usage.cs
@@ -25,6 +25,16 @@ void DirectoryMarkdownProcessorRun()
         #endregion
     }
 
+    void DirectoryMarkdownProcessorRunMaxWidth()
+    {
+        #region DirectoryMarkdownProcessorRunMaxWidth
+
+        var processor = new DirectoryMarkdownProcessor("targetDirectory", maxWidth: 80);
+        processor.Run();
+
+        #endregion
+    }
+
     void ReadingDirectory()
     {
         #region ReadingDirectorySimple