feedback for phpDocumentor 2.8.5 alias php Version 5.3 for Windows

[srgmat srgjung]

Recently I started to become a more professional author of a php package.

I noticed documentation is important - that is how I came across https://www.phpdoc.org/  phpDocumentor.

Here are my observations as a first time user:

Installing using PEAR was a fast disaster as my version of pear was a kind of out of date - I could not even upgrade that thing.

Installation with PHAR worked better - just I had to learn WTF is phar.

mkdir phpDocumentor
cd phpDocumentor
phar.bat extract -f g:\internet\downloads\phar\phpDocumentor.phar ( if one downloaded it into that folder )

Then I was overwhelmed by the thousands of files that were in that package.

Alias:              phpDocumentor.phar
Hash-type:          SHA-1
Hash:               E68AB92FE3377A02F88A03767B9E2AC26467AF76
Entries:            3636
Uncompressed-files: 3636

Next I tried to find out - how does it work

Via link Learn more -> Your first set of Documentation - https://docs.phpdoc.org/latest/getting-started/your-first-set-of-documentation.html

I noticed shortly afterwards about a file:

And under Windows that would be:

$ [PHPDOC_FOLDER]\bin\phpdoc.bat

In my bin folder was no bat file.
just phpdoc - 762 bytes - no file extension
At the command shell I can run it with php phpdoc

Collecting files .. OK
Initializing parser .. OK
Parsing files

[Exception]
No parsable files were found, did you specify any using the -f or -d parameter?

project:run [-t|--target[="..."]] [--cache-folder[="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] 
[--encoding[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] 
[--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [--log[="..."]]

Maybe one could include a parameter --version and return the content of file ../VERSION


Now, let me find out - if it can actually do something


Maybe at the homepage https://www.phpdoc.org/ one could point to instructions for Installation for Windows

I post you again, if I got it to work ( after I enriched my code with DocBlocks )

[Jaapio]

Hi,

phpDocumentor 3.0 is released last month, I would highly recommend you to use that.
v2 is unsupported, and php 5.3 is highly outdate. So I do recommend you to upgrade.

The phar file itself is executable. So you can use "php phpDocumentor.phar" and php will execute the phar like it is a script.

Regards

Jaap

Op dinsdag 7 april 2020 om 20:02:15 UTC+2 schreef srgmat....@gmail.com: