sponsor Vim development Vim logo Vim Book Ad

PDV - phpDocumentor for Vim : Provides really comfortable generation of phpDocumentor doc blocks for PHP4 & 5.

 script karma  Rating 3183/1300, Downloaded by 17487  Comments, bugs, improvements  Vim wiki

created by
Tobias Schlitt
script type
PDV (phpDocumentor for Vim)

Version: 1.0.0

Copyright 2005 by Tobias Schlitt <toby@php.net>
Inspired by phpDoc script for Vim by Vidyut Luther (http://www.phpcult.com/).

Provided under the GPL (http://www.gnu.org/copyleft/gpl.html).

This script provides functions to generate phpDocumentor conform
documentation blocks for your PHP code. The script currently

- Classes
- Methods/Functions
- Attributes

All of those supporting all PHP 4 and 5 syntax elements.

Beside that it allows you to define default values for phpDocumentor tags
like @version (I use $id$ here), @author, @license and so on.

For function/method parameters and attributes, the script tries to guess the
type as good as possible from PHP5 type hints or default values (array, bool,
int, string...).

You can use this script by mapping the function PhpDoc() to any
key combination. Hit this on the line where the element to document
resides and the doc block will be created directly above that line.


Version 1.0.0

* Created the initial version of this script while playing around with VIM
   scripting the first time and trying to fix Vidyut's solution, which
   resulted in a complete rewrite.
install details

For example include into your .vimrc:

source ~/.vim/php-doc.vim
inoremap <C-P> <ESC>:call PhpDocSingle()<CR>i
nnoremap <C-P> :call PhpDocSingle()<CR>
vnoremap <C-P> :call PhpDocRange()<CR>

This includes the script and maps the combination <ctrl>+p
to the doc functions.

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
php-doc.vim 1.0.1 2005-10-11 6.0 Tobias Schlitt - Fixed commenting of tab indented code.
- Fixed some smaller parsing bugs.
- Fixed bug with call-by-reference parameters.
- ATTENTION: This version contains already some code for version 1.1.0, which does not work by now!
php-doc.vim 1.0 2005-09-14 6.0 Tobias Schlitt Initial upload
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.