Unsorted Docs

Just a melting pot for all my documentation
For other Documentation, see:

MD Verb Extensions

Md verb extensions are called when an @verb(arg1, arg2) is found in a markdown source file.

@classMethods(ClassName, visibility)
- @arg ClassName: The class name. You may specify namespace as well.
- @arg visibility: * for any visibility, or public, or private, or protected
  Displays all methods of a class with the given visibility.

@‌classMethods(Tlf\Scrawl\Utility\Php, public) displays:

Php::classesFromDir($classDir): Get all classes in a directory
- @param: $classDir A directory to search
- @return: array ['class'=>$class, 'interfaces'=>['interface1','interface2']]
Php::getClassFromFile($file): Get a fully qualified class name from a file
- @param: $file a file path
- @return: a class name
Php::getInterfacesFromClass($class):

You can execute scrawl. You can interact with the Tlf\Cli class directly in php, or with the Tlf\Scrawl class directly.

For now, you can look at the code base. Also, try running scrawl & saying no(well, n, technically) to the prompt

Configs go in PROJECT_ROOT/.scrawl.json or PROJECT_ROOT/.config/scrawl.json
In cli scrawl --boolAttribute or scrawl -strAttribute strValue to override your json configurations.
- --boolAttribute presence means "set boolAttribute to true"
Your .json file is loaded by Tlf\Cli (when you use the scrawl command). If you instantiate Tlf\Scrawl($projectDir, $configs) in PHP, you'd have to load up configs yourself.
--deleteExistingDocs is a DANGEROUS feature. If true in your .json or provided in your scrawl call, your entire docs folder will be deleted when running scrawl.
Configs in the PHP array provided to Tlf\Scrawl do NOT use - or --. This is purely for predictable cli input parsing.
--markdown.preserveNewLines Adds 2 spaces at the end of every line to ensure Markdown parsers separate those lines in output.
- Defaults true... thus MUST be disabled through .json
There's also a -scrawl.ext config option to load additional extensions. See the config file for this package for an example.
- @TODO properly document -scrawl.ext config.

All default values are determined/picked in the Tlf\Cli class