You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The above command may not work on an existing project due to version conflicts that need to be resolved, so it
30
30
is preferred to add the package manually to the `require` section of your composer.json:
31
31
32
32
```json
33
-
"yiisoft/yii2-apidoc": "~2.1.0"
33
+
"yiisoft/yii2-apidoc": "~3.0.6"
34
34
```
35
35
36
36
afterwards run `composer update`. You may also run `composer update yiisoft/yii2-apidoc cebe/markdown` if you
@@ -39,13 +39,14 @@ want to avoid updating unrelated packages.
39
39
40
40
Usage
41
41
-----
42
+
This extension creates executable at `/vendor/bin`. Please do change directory to that directory if you do not want to use full path i.e `/vendor/bin/apidoc` and use just the executable name as with below examples.
42
43
43
44
This extension offers two commands:
44
45
45
46
1)`api` to generate class API documentation. [phpDocumentor](https://www.phpdoc.org/) is used as a base framework
46
47
so refer to its guide for the syntax.
47
48
48
-
The output of `help api` command:
49
+
The output of `help api` command (i.e `apidoc help api`):
49
50
50
51
```
51
52
DESCRIPTION
@@ -106,7 +107,7 @@ OPTIONS
106
107
107
108
2)`guide` to render nice HTML pages from markdown files such as the yii guide.
108
109
109
-
The output of `help guide` command:
110
+
The output of `help guide` command (i.e `apidoc help guide`):
0 commit comments