From 5ae0405694af26906d01f0b29fb09b1377c83236 Mon Sep 17 00:00:00 2001 From: igloo15 Date: Thu, 18 Apr 2019 21:59:25 -0400 Subject: [PATCH] #Change update tool usage statements #Change update readme text #Summary small release to fix bug #issue-14 --- README.md | 12 ++++++++---- src/MarkdownApi.Tool/Options.cs | 12 ++++++------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9292229..3e7d50c 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,10 @@ nuget install igloo15.MarkdownApi.Core ``` markdownapi --help -markdownapi 0.5.0-dev0011 -Copyright (C) 2019 Igloo15, jyasuu, neuecc +markdownapi 1.0.0 +Copyright (C) 2019 igloo15, jyasuu, neuecc +ERROR(S): +A required value not bound to option name is missing. USAGE: Normal Usage: markdownapi ./MyDll.dll ./Api @@ -67,7 +69,8 @@ markdownapi ./bin/*.dll;./dist/myapp/myApp.dll ../../..docs/Api --event-folder (Default: Events) The folder to store event pages in - --theme (Default: Default) The theme you wish to use. Selecting a theme will potentially override the commandline arguments you have defined + --theme (Default: Default) The theme you wish to use. Selecting a theme will potentially + override the commandline arguments you have defined --default-theme-file (Default: default.settings.json) File containing settings for the default theme @@ -75,7 +78,8 @@ markdownapi ./bin/*.dll;./dist/myapp/myApp.dll ../../..docs/Api --version Display version information. - Dll Path (pos. 0) Required. The path to the dll to create documentation for. May include wildcards on file name. Use ';' to search multiple areas + Dll Path (pos. 0) Required. The path to the dll to create documentation for. May include wildcards on file + name. Use ';' to search multiple areas Output Directory (pos. 1) (Default: md) The root folder to put documentation in ``` diff --git a/src/MarkdownApi.Tool/Options.cs b/src/MarkdownApi.Tool/Options.cs index 706877c..9055359 100644 --- a/src/MarkdownApi.Tool/Options.cs +++ b/src/MarkdownApi.Tool/Options.cs @@ -26,7 +26,7 @@ internal class Options [Option("summary", Default = "", HelpText = "A summary you want to appear on root page")] public string Summary { get; set; } - + [Option("namespace-page", Default = false, HelpText = "Create pages for each namespace")] public bool NamespacePages { get; set; } @@ -66,17 +66,17 @@ internal class Options [Option("theme", Default = "Default", HelpText = "The theme you wish to use. Selecting a theme will potentially override the commandline arguments you have defined")] public string ThemeName { get; set; } - [Option("default-theme-file", Default ="default.settings.json", HelpText = "File containing settings for the default theme")] + [Option("default-theme-file", Default = "default.settings.json", HelpText = "File containing settings for the default theme")] public string DefaultThemeSettingsFile { get; set; } - + [Usage(ApplicationAlias = "markdownapi")] public static IEnumerable Examples { get { yield return new Example("Normal Usage", new Options { DllPath = "./MyDll.dll", Destination = "./Api" }); - yield return new Example("Wildcard Usage", new Options { DllPath = "./bin/*.dll", Destination = "./Api" }); - yield return new Example("Multiple Search Locations", new Options { DllPath = "./bin/*.dll;./dist/myapp/myApp.dll", Destination = "../../..docs/Api" }); + yield return new Example("Wildcard Usage", new Options { DllPath = "./bin/**/myLib/myLib*.dll", Destination = "./Api" }); + yield return new Example("Multiple Search Locations", new Options { DllPath = "./bin/*.dll;./dist/myapp/myApp*.dll", Destination = "../../..docs/Api" }); } } @@ -98,4 +98,4 @@ public DefaultOptions GenerateOptions() return options; } } -} +} \ No newline at end of file