Confusing --hidden flag #1017
Comments
|
I agree that this should be improved, thank you for reporting this |
mvriel
added a commit
to mvriel/phpDocumentor2
that referenced
this issue
May 16, 2014
The hidden command line option should allow phpDocumentor to traverse hidden folders when added but phpDocumentor functioned the other way around; only when the hidden option was provided it did not descend into hidden directories. To clear up any confusion will phpDocumentor now not descend into hidden directories and is the text altered to make this more clear.
|
I have reviewed this issue and indeed, the functionality is contra to what is described in the old manual (http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.hidden) and in the command line help. I have altered the application to show correct behaviour and the text to be more clear in PR #1262 |
ashnazg
added a commit
that referenced
this issue
May 17, 2014
Fixes #1017: Erroneous behaviour of --hidden
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When reading the documentation for the run command i bumped into this flag:
This states that adding the flag enables phpDocumentor2 to also scan hidden directories, and that this option is also by default turned on (there seems to be no option to turn it off), making the
--hiddenflag itself useless by definition.In practice, the
--hiddenparameter does the opposite, it turns this feature off (contrary to both the documentation and what i assumed the flag would do before reading the description). The default behavior without this flag is as stated, phpDocumentor2 will descend into hidden directories.The easiest fix would be to update the description and documentation for this flag to reflect the actual behavior, but the best option would probably be to rename the
--hiddenflag to--ignore-hidden, but that would be a breaking change.The text was updated successfully, but these errors were encountered: