mikehaertl / yii2-apidoc-vim
Yii 2 apidoc as Vim helpfiles
Requires (Dev)
- yiisoft/yii2: 2.0.33
- yiisoft/yii2-apidoc: *
- yiisoft/yii2-authclient: *
- yiisoft/yii2-bootstrap: *
- yiisoft/yii2-composer: *
- yiisoft/yii2-debug: *
- yiisoft/yii2-elasticsearch: *
- yiisoft/yii2-faker: *
- yiisoft/yii2-gii: *
- yiisoft/yii2-httpclient: *
- yiisoft/yii2-imagine: *
- yiisoft/yii2-jui: *
- yiisoft/yii2-mongodb: *
- yiisoft/yii2-queue: *
- yiisoft/yii2-redis: *
- yiisoft/yii2-smarty: *
- yiisoft/yii2-sphinx: *
- yiisoft/yii2-swiftmailer: *
- yiisoft/yii2-twig: *
This package is auto-updated.
Last update: 2024-11-25 17:31:43 UTC
README
Installation
Add mikehaertl/yii2-apidoc-vim to your Vundle configuration.
Alternatively you can download the files from here,
extract the package and move the docs/ directory to your ~/.vim directory.
If the help is not available after installation, you can try to issue this command in VIM:
:helptags ~/.vimrc/doc
How to use
There is no configuration required for this plugin.
:help yii/web/Controller
You should note though, that we use a forward slash (/) instead of a backslash (\) as
namespace separator. This was neccessary because when searching for tags, Vim uses regular
expressions. So any backslash would indicate the start of a search pattern and you would
have to type e.g. yii\\base\\Controller. Autocomplete wouldn't work very well either.
How to create the doc files
Note: This is only required if want to build your own flavour of the help files.
Start in an empty directory and install the yii2-apidoc-vim package via composer:
composer require mikehaertl\yii2-apidoc-vim dev-master
Now you can run the apidocvim command to extract the docs in Vim format from any
source files:
./apidocvim api path/to/some/source/code /path/to/output/dir
You can also use the update-all command to automatically extract the doc files from
the currenty yii2 packages installed in vendor/.
How to customize the created doc files
You can modify the view files in src/templates/views and adjust the render methods in
src/templates/ApiRenderer.php.