Skip to content

Commit 106514d

Browse files
committed
cleanup code generation config and instructions
1 parent 2a3e89f commit 106514d

File tree

5 files changed

+209
-12
lines changed

5 files changed

+209
-12
lines changed

composer.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
"homepage": "http://phpcr.github.com",
66
"license": "MIT",
77
"require": {
8-
"phpdocumentor/template-phpcr": "dev-master@dev"
8+
"phpdocumentor/template-phpcr": "dev-master@dev",
9+
"phpcr/phpcr": "dev-master@dev",
10+
"phpcr/phpcr-utils": "dev-master@dev"
911
}
1012
}

composer.lock

Lines changed: 171 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/config/README

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
1-
See phpcr doc/config/ directory for information how to generate the configuration
1+
This is using the phpDocumentor2, see phpdoc.org
2+
3+
To generate the doc, you currently need to run phpdoc as root (see https://github.com/phpDocumentor/phpDocumentor2/pull/728)
4+
5+
1. Run composer to get the phpDocumentor templates and the source code to be documented
6+
7+
php composer.phar update
8+
9+
(You want to genrate the latest doc, so update and not install)
10+
11+
2. Generate the doc
12+
13+
sudo phpdoc -c phpdoc.dist.xml
14+
sudo phpdoc -c phpdoc-all.dist.xml

doc/config/phpdoc-all.dist.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<!-- documentation file for phpDocumentor2 -->
3+
<phpdoc>
4+
<title>PHPCR API and PHPCR-Utils</title>
5+
<parser>
6+
<target>../html-all/</target>
7+
</parser>
8+
<transformer>
9+
<target>../html-all/</target>
10+
</transformer>
11+
<transformations>
12+
<template name="../../data/templates/phpcr" />
13+
</transformations>
14+
<files>
15+
<directory>../../vendor/phpcr/phpcr/src</directory>
16+
<directory>../../vendor/phpcr/phpcr-utils/src</directory>
17+
</files>
18+
</phpdoc>

doc/config/phpdoc.dist.xml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
<phpdoc>
44
<title>PHPCR API and PHPCR-Utils</title>
55
<parser>
6-
<target>../html-all/</target>
6+
<target>../html/</target>
77
</parser>
88
<transformer>
9-
<target>../html-all/</target>
9+
<target>../html/</target>
1010
</transformer>
1111
<transformations>
1212
<template name="../../data/templates/phpcr" />
1313
</transformations>
1414
<files>
15-
<directory>../../../phpcr/src</directory>
16-
<directory>../../../phpcr-utils/src</directory>
15+
<directory>../../vendor/phpcr/phpcr/src</directory>
1716
</files>
1817
</phpdoc>

0 commit comments

Comments
 (0)