7.4. project:run

7.4.1. Description

7.4.2. Usage

$ docblox -d|-f <PATH> -t <PATH> [parameters]

$ docblox run -d|-f <PATH> -t <PATH> [parameters]

$ docblox project:run -d|-f <PATH> -t <PATH> [parameters]

7.4.3. Parameters

-d

Provide a comma-separated list of source folders to parse.

This parameter can be used to tell DocBlox which folders need to be interpreted. This may be a single relative or absolute path; or a list of paths separated by commas. When providing a relative path please keep in mind that the path is relative to the current working directory.

Wildcards * and ? are supported by this parameter but please keep in mind to surround the parameter value with double quotes or your operating system might try to interpret them instead of DocBlox doing so.

This parameter may be used in conjunction with the -f parameter.

-sourcecode

Starting with 0.16.0, Stores the sourcecode of each file with the structure.

When this parameter is provided will the parser add a compressed, base64-encoded version of the parsed file’s source as child element of the <file> element. This information can then be picked up by the transformer to generate a syntax highlighted view of the file’s source code and even have direct links to specific lines.

Currently the transformer will add a link to the given file’s source next to the name of the file in the top. In the future we will add direct links from elements to the line in this source code file.