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

Documentation on how to configure #24

Open
PixEye opened this issue May 30, 2023 · 0 comments
Open

Documentation on how to configure #24

PixEye opened this issue May 30, 2023 · 0 comments

Comments

@PixEye
Copy link

PixEye commented May 30, 2023

I would like to know which formats are supported at line with 'format' key of the ".phpdoc-md" configuration file.

    'format' => 'github',

What to setup if our PHP project is NOT hosted under Github?

I understand the config line with 'destDirectory' key (destination folder) but that's all about it.
What values do we have to enter at other configuration lines?

    'rootNamespace' => 'Clean\PhpDocMd\Example', // can we set '.'?
    'destDirectory' => 'resources/doc/php', // OK
    'format' => 'github', // what other format(s)?
    'classes' => [ ... ] // do we have to list all classes of the project? (it could be many)

Some more documentation would be appreciated please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants