Howto Integrate vendor docs in phpdoc?

Question

Is there a way to configure phpdoc so that it will also generate docs for all installed vendor apps with composer?

Why? Well because it would be very nice to have just one doc enviroment wich provides all the docs with the current version of your app and all of your vendor apps. You can just search your own doc enviroment to check out how you should speak to an object belonging to laravel or Zend or whatever you need.

My current phpdoc.xml looks like this:

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>App title</title>
    <parser>
        <default-package-name>RootNamespace\app\</default-package-name>
        <target>docs</target>
        <markers>
            <item>TODO</item>
            <item>FIXME</item>
        </markers>
        <extensions>
            <extension>php</extension>
            <extension>php3</extension>
            <extension>phtml</extension>
        </extensions>
        <visibility></visibility>
    </parser>
    <transformer>
        <target>docs</target>
    </transformer>
    <logging>
        <level>warn</level>
        <paths>
            <default>{APP_ROOT}/data/log/{DATE}.log</default>
            <errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors>
        </paths>
    </logging>
    <files>
        <ignore>src/View/*</ignore>
        <ignore>tests/*</ignore>
        <directory>src</directory>
    </files>
</phpdoc>

Please don't answer with just "No". Somebody must've figured this out.

Assuming your phpdoc.xml is in your top-level directory, then I should think: <files><directory>vendor/**/*</directory><ignore>vendor/bin</ignore><ignore>vendor/composer</ignore></files> — bishop
– bishop, Commented Sep 9, 2015 at 16:03

RTB · Accepted Answer · 2015-12-02 21:02:11Z

1

The Comment from @bishop worked for me:

Assuming your phpdoc.xml is in your top-level directory then this works:

<files>
    <directory>vendor/**/*</directory>
    <directory>src</directory>
    <ignore>vendor/bin</ignore>
    <ignore>vend‌or/composer</ignore>
    <ignore>src/View/*</ignore>
    <ignore>tests/*</ignore>
</files>

answered Dec 2, 2015 at 21:02

RTB

5,8337 gold badges36 silver badges51 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Kristian Matthews-Kennington Over a year ago

How can this be done in reverse; ignore all the vendor directories except certain ones, rather than ignoring certain ones?

Collectives™ on Stack Overflow

Howto Integrate vendor docs in phpdoc?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related