sponsor Vim development Vim logo Vim Book Ad

vim-doge : Generate proper code documentation skeletons with a single keypress.

 script karma  Rating 70/19, Downloaded by 1269  Comments, bugs, improvements  Vim wiki

created by
Kim Koomen
 
script type
ftplugin
 
description
We all love documentation because it makes our codebases easier to understand, yet no one has time to write it in a good and proper way.

DoGe is a (Do)cumentation (Ge)nerator which will generate a proper documentation skeleton based on certain expressions (mainly functions). Simply put your cursor on a function, press <Leader>d, jump quickly through TODO items using <Tab> and <S-Tab> to quickly add descriptions and go on coding!
 
install details
Using vim-pack:

    git clone -- depth 1 https://github.com/kkoomen/vim-doge ~/.vim/pack/*/start/vim-doge

Using pathogen:

    git clone -- depth 1 https://github.com/kkoomen/vim-doge ~/.vim/bundle/vim-doge

Using plug:

    Plug 'kkoomen/vim-doge'
 

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
vim-doge-1.14.0.tar.gz 1.14.0 2019-10-25 7.4 Kim Koomen Improve JavaScript and TypeScript generation.
Configurable option to disable certain modes in which doge will bind the jump forward/backward triggers.
Deactivate DoGe immediately when needed.
vim-doge-1.13.1.tar.gz 1.13.1 2019-09-12 7.4 Kim Koomen Prevent highlight flickering when jumping.
Persist search history.
vim-doge-1.13.0.tar.gz 1.13.0 2019-09-12 7.4 Kim Koomen Support continues placeholder cycling.
Map and unmap jump mappings when doge activates/deactivates.
vim-doge-1.12.0.tar.gz 1.12.0 2019-09-10 7.4 Kim Koomen Support Vim 7.4+ instead of 8.0+ by custom trim() function for backward compatibility.
vim-doge-1.11.2.tar.gz 1.11.2 2019-08-26 8.0 Kim Koomen Optimise comment generation for Java.
vim-doge-1.11.1.tar.gz 1.11.1 2019-07-30 8.0 Kim Koomen Add PHP TODO context for class properties including missing tests.
vim-doge-1.11.0.tar.gz 1.11.0 2019-07-29 8.0 Kim Koomen Add a configurable setting to enable or disable mappings.
vim-doge-1.10.0.tar.gz 1.10.0 2019-07-28 8.0 Kim Koomen Add the :DogeGenerate command to generate documentation.
vim-doge-1.9.3.tar.gz 1.9.3 2019-07-28 8.0 Kim Koomen Allow whitespace before the colon when using type hints in Python.
vim-doge-1.9.2.tar.gz 1.9.2 2019-07-28 8.0 Kim Koomen Filter out the self parameter in Python methods.
vim-doge-1.9.1.tar.gz 1.9.1 2019-07-28 8.0 Kim Koomen Prevent indenting when empty line.
vim-doge-1.9.0.tar.gz 1.9.0 2019-07-27 8.0 Kim Koomen Add support for JavaScript ES6 class properties.
vim-doge-1.8.2.tar.gz 1.8.2 2019-07-27 8.0 Kim Koomen Remove additional whiteline after javascript main function description.
vim-doge-1.8.1.tar.gz 1.8.1 2019-07-27 8.0 Kim Koomen Use correct phpdoc description format for PHP.
vim-doge-1.8.0.tar.gz 1.8.0 2019-07-27 8.0 Kim Koomen Implement @return tag for PHP functions and class-methods.
vim-doge-1.7.0.tar.gz 1.7.0 2019-07-27 8.0 Kim Koomen Add javascript/typescript pattern for functions inside objects.
vim-doge-1.6.1.tar.gz 1.6.1 2019-07-27 8.0 Kim Koomen Update C++ regex to match 0 or more occurences in the regex pattern instead of making it optional.
vim-doge-1.6.0.tar.gz 1.6.0 2019-07-27 8.0 Kim Koomen Add TODO contexts for every language.
vim-doge-1.5.3.tar.gz 1.5.3 2019-07-27 8.0 Kim Koomen Update Roxygen skeleton for R with @return and @examples tags.
vim-doge-1.5.2.tar.gz 1.5.2 2019-07-27 8.0 Kim Koomen Allow colon inside C++ angle bracket notation in the return type.
vim-doge-1.5.1.tar.gz 1.5.1 2019-07-27 8.0 Kim Koomen Fix python google style return type position.
vim-doge-1.5.0.tar.gz 1.5.0 2019-07-27 8.0 Kim Koomen Add Sphinx doc standard for Python.
vim-doge-1.4.7.tar.gz 1.4.7 2019-07-27 8.0 Kim Koomen Use start of docblock for the description instead of @description tag for javascript/typescript.

vim-doge-1.4.6.tar.gz 1.4.6 2019-07-19 8.0 Kim Koomen Add & in C++ function regex var name to match a specific case.
vim-doge-1.4.5.tar.gz 1.4.5 2019-07-18 8.0 Kim Koomen Allow dot-characters in python parameter type hint.
vim-doge-1.4.4.tar.gz 1.4.4 2019-07-18 8.0 Kim Koomen Preprocess indent position for python for inserting below declaration and adjust preprocess order.
vim-doge-1.4.3.tar.gz 1.4.3 2019-07-18 8.0 Kim Koomen Optimise plugin root check to allow nvim 0.3.2+.
vim-doge-1.4.2.tar.gz 1.4.2 2019-07-18 8.0 Kim Koomen Remove <unique> to fix mapping-already-exists error.
vim-doge-1.4.1.tar.gz 1.4.1 2019-07-18 8.0 Kim Koomen Do not display error msg when no generation can be done.
vim-doge-1.4.0.tar.gz 1.4.0 2019-07-18 8.0 Kim Koomen Support TODO contexts.
vim-doge-1.3.2.tar.gz 1.3.2 2019-07-18 8.0 Kim Koomen Change default g:doge_mapping to <Leader>d instead of <C-d>.
vim-doge-1.3.1.tar.gz v1.3.1 2019-07-16 8.0 Kim Koomen Fix catch statements for different locales.
vim-doge-1.3.0.tar.gz 1.3.0 2019-07-13 8.0 Kim Koomen Add support for Google styleguide doc for Python.
vim-doge-1.2.3.tar.gz 1.2.3 2019-07-13 8.0 Kim Koomen Prevent @return tag to be added when returning void in C++.
vim-doge-1.2.2.tar.gz 1.2.2 2019-07-13 8.0 Kim Koomen Added a line for extended description for python numpy doc.
vim-doge-1.2.1.tar.gz 1.2.1 2019-07-13 8.0 Kim Koomen Support declarations for C++ along with support for advanced function syntax.
vim-doge-1.2.0.tar.gz 1.2.0 2019-06-29 8.0 Kim Koomen Add support for C++.
vim-doge-1.1.0.tar.gz 1.1.0 2019-06-29 8.0 Kim Koomen Add support for multiple doc standard per filetype.
vim-doge-1.0.0.tar.gz 1.0.0 2019-06-25 8.0 Kim Koomen Initial upload
ip used for rating: 100.24.115.253

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.
   
OSDN.net Logo