usage.txt


markdownapi 0.4.0
Copyright (C) 2018 Igloo15, jyasuu, neuecc
USAGE:
Normal Usage:
markdownapi ./MyDll.dll ./Api

  --namespace-filter           (Default: ) A regex used to generate documentation only for namespaces that match

  --root-filename              (Default: Home) The name of the markdown file at the root of your documentation

  --title                      (Default: Api) Title of the root home page

  --summary                    (Default: ) A summary you want to appear on root page

  --namespace-page             (Default: false) Create pages for each namespace

  --type-page                  (Default: true) Create pages for each type

  --constructor-page           (Default: false) Create pages for each constructor

  --method-page                (Default: false) Create pages for each method

  --property-page              (Default: false) Create pages for each property

  --field-page                 (Default: false) Create pages for each field

  --event-page                 (Default: false) Create pages for each event

  --method-folder              (Default: Methods) The folder to store method pages in

  --constructors-folder        (Default: Constructors) The folder to store constructor pages in

  --property-folder            (Default: Properties) The folder to store property pages in

  --field-folder               (Default: Fields) The folder to store field pages in

  --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

  --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

  Output Directory (pos. 1)    (Default: md) The root folder to put documentation in