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
-
@classMethods(ClassName, visibility)
-
@arg ClassName
: The class name. You may specify namespace as well. -
@arg visibility
:*
for any visibility, orpublic
, orprivate
, orprotected
Displays all methods of a class with the given visibility.
-
@classMethods example
@‌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)
:
Executing Code Scrawl
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 for Code Scrawl
To know:
- Configs go in
PROJECT_ROOT/.scrawl.json
orPROJECT_ROOT/.config/scrawl.json
- In cli
scrawl --boolAttribute
orscrawl -strAttribute strValue
to override yourjson
configurations.-
--boolAttribute
presence means "setboolAttribute
to true"
-
- Your
.json
file is loaded byTlf\Cli
(when you use thescrawl
command). If you instantiateTlf\Scrawl($projectDir, $configs)
in PHP, you'd have to load up configs yourself. -
--deleteExistingDocs
is a DANGEROUS feature. Iftrue
in your.json
or provided in yourscrawl
call, your entiredocs
folder will be deleted when runningscrawl
. - 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
- Defaults
- 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.
- @TODO properly document
Available configs & their default values:
All default values are determined/picked in the Tlf\Cli
class
- dir.docs:
docs
ordoc
ordoc
- dir.template:
docs-src
ordoc-src
ordocs-src
- dir.code:
src
orcode
orsrc
- file.conf:
.config/scrawl.json
or.scrawl.json
or.config/scrawl.json
- file.code.ext:
*
- file.template.ext:
.src.md
- deleteExistingDocs:
false
- markdown.preserveNewLines:
true
- markdown.prependGenNotice:
true
- scrawl.ext:
[]
- readme.copyFromDocs:
true
- ext.PhpApiScraper:
true