Skip to content

Commit 7148f0e

Browse files
committed
Integrates JSDoc and phpDoc in composer doc command.
1 parent d4e0014 commit 7148f0e

4 files changed

Lines changed: 7 additions & 5 deletions

File tree

‎composer.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@
3131
"info.html": "@php docs/info.php > docs/info.html",
3232
"doc": [
3333
"@info.html",
34-
"doxygen Doxyfile"
34+
"doxygen Doxyfile",
35+
"./node_modules/.bin/jsdoc -c jsdoc.json",
36+
"php tools/phpDocumentor"
3537
],
3638
"minify": "php -r \"require 'src/php/minifier.php';minify_everything();\"",
3739
"no-minify": [

‎docs/CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ones are marked like "v1.0.0-fork".
1515

1616
## Changed
1717

18-
* PHP file header docblocks are expanded, notably with a PHP version, package and category name.
18+
* PHP files header docblocks are expanded, notably with a PHP version, package and category name.
1919

2020
### Deprecated
2121

‎docs/contribute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ The steps to publish a new version are:
161161
1. In the [CHANGELOG](./CHANGELOG.md), add the latest release number and date.
162162
2. Update `get_version` in `inc/kernel_utility.php` with the release number and date.
163163
3. Update `PROJECT_NUMBER` in `Doxyfile` to the latest release number.
164-
4. Regenerate documentation with `composer doc` and `./node_modules/.bin/jsdoc -c jsdoc.json`.
164+
4. Regenerate documentation with `composer doc`.
165165
5. Commit your changes, `git commit -m "Regenerates documentation for release []."`
166166
6. Add a version tag with annotation `git tag -a [release number]` and push the changes.
167167
7. If all the GitHub actions are successfull, write a new release on GitHub linking to the previously created tag.

‎docs/info.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1645,7 +1645,7 @@ <h3>New version</h3>
16451645
<li>In the <a href="./CHANGELOG.md">CHANGELOG</a>, add the latest release number and date.</li>
16461646
<li>Update <code>get_version</code> in <code>inc/kernel_utility.php</code> with the release number and date.</li>
16471647
<li>Update <code>PROJECT_NUMBER</code> in <code>Doxyfile</code> to the latest release number.</li>
1648-
<li>Regenerate documentation with <code>composer doc</code> and <code>./node_modules/.bin/jsdoc -c jsdoc.json</code>.</li>
1648+
<li>Regenerate documentation with <code>composer doc</code>.</li>
16491649
<li>Commit your changes, <code>git commit -m "Regenerates documentation for release []."</code>
16501650
</li>
16511651
<li>Add a version tag with annotation <code>git tag -a [release number]</code> and push the changes.</li>
@@ -2178,7 +2178,7 @@ <h4>Added</h4>
21782178
</ul>
21792179
<h3>Changed</h3>
21802180
<ul>
2181-
<li>PHP file header docblocks are expanded, notably with a PHP version, package and category name.</li>
2181+
<li>PHP files header docblocks are expanded, notably with a PHP version, package and category name.</li>
21822182
</ul>
21832183
<h4>Deprecated</h4>
21842184
<ul>

0 commit comments

Comments
 (0)