You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@netbeans.apache.org by "Vítězslav Dvořák (Jira)" <ji...@apache.org> on 2020/10/31 06:45:00 UTC
[jira] [Updated] (NETBEANS-4901) phpDocumentor commandline
arguments change
[ https://issues.apache.org/jira/browse/NETBEANS-4901?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vítězslav Dvořák updated NETBEANS-4901:
---------------------------------------
Attachment: image-2020-10-31-07-44-06-328.png
> phpDocumentor commandline arguments change
> ------------------------------------------
>
> Key: NETBEANS-4901
> URL: https://issues.apache.org/jira/browse/NETBEANS-4901
> Project: NetBeans
> Issue Type: Improvement
> Components: php - PHPDoc
> Affects Versions: 11.1
> Reporter: Vítězslav Dvořák
> Assignee: Junichi Yamamoto
> Priority: Minor
> Fix For: 12.2
>
> Attachments: image-2020-10-31-07-44-06-328.png
>
>
> New phpdoc 3.0.0+ use different commandline syntax:
>
> {color:#b26818}Options:{color}
> {color:#18b218}-t, --target[=TARGET]{color}{color:#000000} Path where to store the generated output {color}
> {color:#18b218} --cache-folder[=CACHE-FOLDER]{color}{color:#000000} Path where to store the cache files {color}
> {color:#18b218}-f, --filename[=FILENAME]{color}{color:#000000} File to parse, glob patterns are supported. Provide multiple options of this type to add {color}
> multiple files.{color:#b26818} (multiple values allowed){color}
> {color:#18b218}-d, --directory[=DIRECTORY]{color}{color:#000000} directory to parse, glob patterns are supported. Provide multiple options of this type to add {color}
> multiple directories.{color:#b26818} (multiple values allowed){color}
> {color:#18b218} --encoding[=ENCODING]{color}{color:#000000} encoding to be used to interpret source files with {color}
> {color:#18b218} --extensions[=EXTENSIONS]{color}{color:#000000} Provide multiple options of this type to add multiple extensions. default is php{color}{color:#b26818} (multiple values allowed){color}
> {color:#18b218}-i, --ignore[=IGNORE]{color}{color:#000000} File(s) and directories (relative to the source-code directory) that will be ignored. Glob patterns are supported. Add multiple options of this type of add more {color}
> ignore patterns{color:#b26818} (multiple values allowed){color}
> {color:#18b218} --ignore-tags[=IGNORE-TAGS]{color}{color:#000000} Tag that will be ignored, defaults to none. package, subpackage and ignore may not be ignored. Add multiple options of this type to ignore multiple tags.{color}{color:#b26818} (multip{color}
> le values allowed) {color:#000000} {color}
> {color:#18b218} --hidden{color}{color:#000000} Use this option to tell phpDocumentor to parse files and directories that begin with a period (.), by default these are ignored {color}
> {color:#18b218} --ignore-symlinks{color}{color:#000000} Ignore symlinks to other files or directories, default is on {color}
> {color:#18b218}-m, --markers[=MARKERS]{color}{color:#000000} Comma-separated list of markers/tags to filter{color}{color:#b26818} (multiple values allowed){color}
> {color:#18b218} --title[=TITLE]{color}{color:#000000} Sets the title for this project; default is the phpDocumentor logo {color}
> {color:#18b218} --force{color}{color:#000000} Forces a full build of the documentation, does not increment existing documentation {color}
> {color:#18b218} --validate{color}{color:#000000} Validates every processed file using PHP Lint, costs a lot of performance {color}
> {color:#18b218} --visibility[=VISIBILITY]{color}{color:#000000} Specifies the parse visibility that should be displayed in the documentation. Add multiple options of {color}
> this type to specify multiple levels.("public,protected"){color:#b26818} (multiple values allowed){color}
> {color:#18b218} --defaultpackagename[=DEFAULTPACKAGENAME]{color}{color:#000000} Name to use for the default package.{color}{color:#b26818} [default: "Default"]{color}
> {color:#18b218} --sourcecode{color}{color:#000000} Whether to include syntax highlighted source code {color}
> {color:#18b218} --template[=TEMPLATE]{color}{color:#000000} Name of the template to use (optional){color}{color:#b26818} (multiple values allowed){color}
> {color:#18b218} --examples-dir[=EXAMPLES-DIR]{color}{color:#000000} Directory to seacher for example files referenced by @example tags {color}
> {color:#18b218}-s, --setting[=SETTING]{color}{color:#000000} Provide custom setting(s) as "key=value", run again with {color}{color:#18b218}--list-settings{color}{color:#000000} for a list{color}{color:#b26818} (multiple values allowed){color}
> {color:#18b218} --list-settings{color}{color:#000000} Returns a list of available settings {color}
> {color:#18b218} --parseprivate{color}{color:#000000} Whether to parse DocBlocks marked with @internal tag {color}
> {color:#18b218}-h, --help{color}{color:#000000} Display this help message {color}
> {color:#18b218}-q, --quiet{color}{color:#000000} Do not output any message {color}
> {color:#18b218}-V, --version{color}{color:#000000} Display this application version {color}
> {color:#18b218} --ansi{color}{color:#000000} Force ANSI output {color}
> {color:#18b218} --no-ansi{color}{color:#000000} Disable ANSI output {color}
> {color:#18b218}-n, --no-interaction{color}{color:#000000} Do not ask any interactive question {color}
> {color:#18b218}-c, --config[=CONFIG]{color}{color:#000000} Location of a custom configuration file {color}
> {color:#18b218} --log[=LOG]{color}{color:#000000} Log file to write to {color}
> {color:#18b218}-e, --env=ENV{color}{color:#000000} The Environment name.{color}{color:#b26818} [default: "prod"]{color}
> {color:#18b218} --no-debug{color}{color:#000000} Switches off debug mode. {color}
> {color:#18b218}-v|vv|vvv, --verbose{color}{color:#000000} Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug {color}
>
>
> Current calling won't work:
>
> "/usr/bin/php" "/usr/bin/phpdoc" "run" "--ansi" "--progressbar" "--directory" "/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee" "--target" "/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee/doc" "--title" "Toggl to FlexiBee"
> Done.
> 14:04:18 ERROR [console] Error thrown while running command "run --ansi --progressbar --directory '/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee' --target '/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee/doc' --title 'Toggl to FlexiBee'". Message: "The "--progressbar" option does not exist." ["exception" => Symfony\Component\Console\Exception\RuntimeException]8;;netbeans://phar:///usr/bin/phpdoc/vendor/symfony/console/Exception/RuntimeException.php?line=17\^]8;;\ \{ …},"command" => "run --ansi --progressbar --directory '/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee' --target '/home/vitex/Projects/VitexSoftware/FlexiBee/Toggl-to-FlexiBee/doc' --title 'Toggl to FlexiBee'","message" => "The "--progressbar" option does not exist."]
> {color:#de350b}*The "--progressbar" option does not exist.*{color}
> project:run [-t|--target [TARGET]] [--cache-folder [CACHE-FOLDER]] [-f|--filename [FILENAME]] [-d|--directory [DIRECTORY]] [--encoding [ENCODING]] [--extensions [EXTENSIONS]] [-i|--ignore [IGNORE]] [--ignore-tags [IGNORE-TAGS]] [--hidden] [--ignore-symlinks] [-m|--markers [MARKERS]] [--title [TITLE]] [--force] [--validate] [--visibility [VISIBILITY]] [--defaultpackagename [DEFAULTPACKAGENAME]] [--sourcecode] [--template [TEMPLATE]] [--examples-dir [EXAMPLES-DIR]] [-s|--setting [SETTING]] [--list-settings] [--parseprivate] [-h|--help] [-q|--quiet] [-v|vv|vvv|--verbose] [-V|--version] [--ansi] [--no-ansi] [-n|--no-interaction] [-c|--config [CONFIG]] [--log [LOG]] [-e|--env ENV] [--no-debug] [--] <command>
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@netbeans.apache.org
For additional commands, e-mail: commits-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists