Uploaded image for project: 'NetBeans'
  1. NetBeans
  2. NETBEANS-4901

phpDocumentor commandline arguments change

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 11.1
    • 12.2
    • php - PHPDoc

    Description

      New phpdoc 3.0.0+ use different commandline syntax:

       

      Options:
       -t, --target[=TARGET]                          Path where to store the generated output
           --cache-folder[=CACHE-FOLDER]              Path where to store the cache files
       -f, --filename[=FILENAME]                      File to parse, glob patterns are supported. Provide multiple options of this type to add
                                                      multiple files. (multiple values allowed)
       -d, --directory[=DIRECTORY]                    directory to parse, glob patterns are supported. Provide multiple options of this type to add
                                                      multiple directories. (multiple values allowed)
           --encoding[=ENCODING]                      encoding to be used to interpret source files with
           --extensions[=EXTENSIONS]                  Provide multiple options of this type to add multiple extensions. default is php (multiple values allowed)
       -i, --ignore[=IGNORE]                          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
      ignore patterns (multiple values allowed)
           --ignore-tags[=IGNORE-TAGS]                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. (multip
      le values allowed)                                                                                                                                                                                                 
           --hidden                                   Use this option to tell phpDocumentor to parse files and directories that begin with a period (.), by default these are ignored
           --ignore-symlinks                          Ignore symlinks to other files or directories, default is on
       -m, --markers[=MARKERS]                        Comma-separated list of markers/tags to filter (multiple values allowed)
           --title[=TITLE]                            Sets the title for this project; default is the phpDocumentor logo
           --force                                    Forces a full build of the documentation, does not increment existing documentation
           --validate                                 Validates every processed file using PHP Lint, costs a lot of performance
           --visibility[=VISIBILITY]                  Specifies the parse visibility that should be displayed in the documentation. Add multiple options of
                                                      this type to specify multiple levels.("public,protected") (multiple values allowed)
           --defaultpackagename[=DEFAULTPACKAGENAME]  Name to use for the default package. [default: "Default"]
           --sourcecode                               Whether to include syntax highlighted source code
           --template[=TEMPLATE]                      Name of the template to use (optional) (multiple values allowed)
           --examples-dir[=EXAMPLES-DIR]              Directory to seacher for example files referenced by @example tags
       -s, --setting[=SETTING]                        Provide custom setting(s) as "key=value", run again with --list-settings for a list (multiple values allowed)
           --list-settings                            Returns a list of available settings
           --parseprivate                             Whether to parse DocBlocks marked with @internal tag
       -h, --help                                     Display this help message
       -q, --quiet                                    Do not output any message
       -V, --version                                  Display this application version
           --ansi                                     Force ANSI output
           --no-ansi                                  Disable ANSI output
       -n, --no-interaction                           Do not ask any interactive question
       -c, --config[=CONFIG]                          Location of a custom configuration file
           --log[=LOG]                                Log file to write to
       -e, --env=ENV                                  The Environment name. [default: "prod"]
           --no-debug                                 Switches off debug mode.
       -v|vv|vvv, --verbose                           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

       

      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."]

      The "--progressbar" option does not exist.

      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>

       

      Attachments

        1. image-2020-10-31-07-44-06-328.png
          170 kB
          Vítězslav Dvořák

        Activity

          People

            junichi11 Junichi Yamamoto
            vitex Vítězslav Dvořák
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: