Skip to content

Commit

Permalink
#Change update tool usage statements
Browse files Browse the repository at this point in the history
#Change update readme text
#Summary small release to fix bug #issue-14
  • Loading branch information
igloo15 committed Apr 19, 2019
1 parent c902e60 commit 5ae0405
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -67,15 +69,17 @@ 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
--help Display this help screen.
--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
```
Expand Down
12 changes: 6 additions & 6 deletions src/MarkdownApi.Tool/Options.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down Expand Up @@ -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<Example> 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" });
}
}

Expand All @@ -98,4 +98,4 @@ public DefaultOptions GenerateOptions()
return options;
}
}
}
}

0 comments on commit 5ae0405

Please sign in to comment.