Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide for running phpDocumentor includes wrong examples #3617

Closed
SamsonQuitt opened this issue Nov 3, 2023 · 3 comments
Closed

Guide for running phpDocumentor includes wrong examples #3617

SamsonQuitt opened this issue Nov 3, 2023 · 3 comments

Comments

@SamsonQuitt
Copy link

Provided Example in Page "running phpDocumentor" misses a "run"

Expected behavior

I can use the provided examples in the page because they are correct.

Actual behavior

The provided examples miss the "run" right after calling phpdoc. This example won't work unless you define a corresponding alias, which is not covered this way in installation.

Steps to reproduce the problem

  1. Go to url: https://docs.phpdoc.org/guide/guides/running-phpdocumentor.html
  2. Look at example
  3. Example ist wrong
@phpdoc-bot phpdoc-bot added this to Needs triage in phpDoc issue triage board Nov 3, 2023
@neoacevedo
Copy link

I agree. If you run the command as is in the page, you will get an error saying command "./src" is not defined.

@IncubuzzCC
Copy link

It took me a while to figure out that same issue.
What you do is add run before your options:
phpdoc run -d path/to/my/project -f path/to/an/additional/file -t path/to/my/output/folder
I hope this helps...

@jaapio
Copy link
Member

jaapio commented May 8, 2024

This will be solved in our next release. We turned phpdoc into a single command application and updated the docs according to that.

@jaapio jaapio closed this as completed May 8, 2024
phpDoc issue triage board automation moved this from Needs triage to Closed May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

4 participants