Skip to content

Commit 5e92e92

Browse files
committed
docs: update notes about phpDocumentor3 compatibility
1 parent fc526fd commit 5e92e92

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/ph
4242

4343
- PHP >= 5.6
4444
- Node.js >= 8
45-
- [phpDocumentor](https://www.phpdoc.org/).
45+
- [phpDocumentor](https://www.phpdoc.org/) 2.
4646
- [Yarn](https://yarnpkg.com) (or npm)
4747
- [VuePress](https://vuepress.vuejs.org/).
4848

4949
> This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 1](https://v0.vuepress.vuejs.org/).
5050
> Read more about dependencies in the [Documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/getting-started.html).
5151
52+
> Note: phpDocumentor 2 is able to generate documentation of code written on maybe any version of PHP < 8, but should be run on PHP 7.2. You can configure a CI like Travis CI, Netlify of Github Actions to generate the documentation on PHP 7.2 for your code if not using it on your local environment. Compatibility with phpDocumentor 3 is in progress 🚧 to support new features it offers.
53+
5254
## Installation
5355

5456
Install `nelson6e65/phpdoc-vuepress` with composer:
@@ -57,7 +59,7 @@ Install `nelson6e65/phpdoc-vuepress` with composer:
5759
composer require --dev nelson6e65/phpdoc-vuepress
5860
```
5961

60-
> You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
62+
> **Note for pre-releases:** You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' or 'beta' in order to be able to install pre-releases.
6163
6264
## Usage
6365

docs/guide/configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Configuring phpDocumentor
44

5-
> These instructions are for phpDocumentor 2, but similar approachment will be valid for phpDocumentor 3.
5+
> These instructions are for phpDocumentor 2. phpDocumentor 3 is not _yet_ compatible.
66
77
You need to tell phpDocumentor (1) where are your PHP source files, (2) where to generate the API documentation and (3) where is the template (for a Composer project, is ). You can, also, (4) configure which elements include by its visibility.
88

@@ -108,4 +108,4 @@ And then just run `composer phpdoc` :sunglasses:.
108108

109109
:::
110110

111-
> For further information, check the [Runing phpDocumentor documentation](https://docs.phpdoc.org/guides/running-phpdocumentor.html).
111+
> For further information, check the [Runing phpDocumentor documentation](https://docs.phpdoc.org/2.9/guides/running-phpdocumentor.html).

docs/guide/getting-started.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,29 @@
88

99
### Dependencies
1010

11-
- **phpDocumentor**: This template is designed for [phpDocumentor 2.x (2.9.1)](https://github.com/phpDocumentor/phpDocumentor#phpdocumentor), but may be compatible with upcoming **phpDocumentor3**.
11+
- **phpDocumentor 2**: This template is designed for [phpDocumentor 2.x (2.9.1)](https://github.com/phpDocumentor/phpDocumentor/tree/2.9#readme).
1212
- **VuePress**: You can use the [version 1.x](https://v1.vuepress.vuejs.org/) by default, but you can also use [version 0.x](https://v0.vuepress.vuejs.org/), depending on your configuration compatibility.
1313

1414
You can globally install them:
1515

1616
```bash
1717
# phpDocumentor2 globally
18-
composer global require phpdocumentor/phpdocumentor:^2.9.0
18+
composer global require phpdocumentor/phpdocumentor:^2.9.1
1919

2020
# VuePress
2121
npm i -D vuepress
2222
```
2323

2424
> Read about [VuePress install](https://vuepress.vuejs.org/guide/getting-started.html).
2525
26+
::: warning phpDocumentor3 compatibility
27+
At the moment, this template _is not compatible_ with the stable release of **phpDocumentor 3**, which supports new features of the latest PHP versions.
28+
29+
It should generate documentation of any code written on PHP < 8, but, as **phpDocumentor 2**, the documentation should be generated on PHP 7.2 or 7.3. You can configure a CI like Travis CI, Netlify of Github Actions to generate the API documentation on PHP 7.2 for your code if not using it on your local environment.
30+
31+
Compatibility with **phpDocumentor 3** is in progress 🚧 to support new features it offers.
32+
:::
33+
2634
## Installation
2735

2836
Install `nelson6e65/phpdoc-vuepress` with composer:
@@ -31,7 +39,7 @@ Install `nelson6e65/phpdoc-vuepress` with composer:
3139
composer require --dev nelson6e65/phpdoc-vuepress
3240
```
3341

34-
> You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
42+
> Pre-releases: You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
3543
3644
## Usage
3745

0 commit comments

Comments
 (0)