created by

Kim 金可明

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 plug:     - Plug 'kkoomen/vim-doge', { 'do': { -> doge#install() } } Using vim-pack:     - git clone --recursive --depth 1 https://github.com/kkoomen/vim-doge ~/.vim/pack/*/start/vim-doge     - Open Vim and run :call doge#install() Using Pathogen:     - git clone --recursive --depth 1 https://github.com/kkoomen/vim-doge ~/.vim/bundle/vim-doge     - Open Vim and run :call doge#install() Using Vundle:     - Plugin 'kkoomen/vim-doge'     - Open Vim and run :call doge#install()

Click on the package to download.

package	script version	date	Vim version	user	release notes
vim-doge-3.21.0.tar.gz	3.21.0	2023-05-05	7.4	Kim 金可明	rust lang: insert docblock above macros
vim-doge-3.20.0.tar.gz	3.20.0	2023-05-05	7.4	Kim 金可明	c/c++ changes: - add docblock tag custom char config option (closes #534) by @kkoomen in #556 - add in-out direction docblock param jumps
vim-doge-3.19.0.tar.gz	3.19.0	2022-12-27	7.4	Kim 金可明	python: add omit_redundant_param_types option
vim-doge-3.18.0.tar.gz	3.18.0	2022-08-20	7.4	Kim 金可明	- Remove CreateDocStandard command - Add 3 new doc standards for C and C++
vim-doge-3.10.0.tar.gz	3.10.0	2021-04-29	7.4	Kim 金可明	Add new option in TypeScript/JavaScript to remove redundant types.
vim-doge-3.9.1.tar.gz	3.9.1	2021-03-29	7.4	Kim 金可明	Support pointer return types in C.
vim-doge-3.9.0.tar.gz	3.9.0	2021-03-15	7.4	Kim 金可明	Add support for Rust with rustdoc.
vim-doge-3.8.1.tar.gz	3.8.1	2021-03-15	7.4	Kim 金可明	Fix MacOS build issue by replacing vercel/pkg with caxa.
vim-doge-3.7.0.tar.gz	3.7.0	2021-02-17	7.4	Kim 金可明	- Fix CI tests not throwing correct error code. - Fix failing tests. - Fix DogeCreateDocStandards generated code.
vim-doge-3.6.0.tar.gz	3.6.0	2020-12-20	7.4	Kim 金可明	- cpp: support functions that return pointers. - support headless mode for CI, docker and similar environments.
vim-doge-3.5.4.tar.gz	3.5.4	2020-11-18	7.4	Kim 金可明	Add dash compatibility for install script.
vim-doge-3.5.2.tar.gz	3.5.2	2020-11-16	7.4	Kim 金可明	- Improve doge#install() for all platforms to run async. - Do not download vim-doge binary if already latest version.
vim-doge-3.4.1.tar.gz	3.4.1	2020-10-25	7.4	Kim 金可明	Do not generate docblocks for function calls in TypeScript/JavaScript.
vim-doge-3.4.0.tar.gz	3.4.0	2020-10-24	7.4	Kim 金可明	- Fix broken linux binaries - Use GitHub Actions workflows instead of Travis. - C++ virtual functions support.
vim-doge-3.3.1.tar.gz	3.3.1	2020-10-21	7.4	Kim 金可明	- Add support for TSX/JSX in TypeScript/JavaScript filetypes. - use archived binaries for faster downloads.
vim-doge-3.2.9.tar.gz	3.2.9	2020-10-17	7.4	Kim 金可明	Support TSX/JSX
vim-doge-3.2.5.tar.gz	3.2.5	2020-10-17	7.4	Kim 金可明	Remove prerequisites NodeJS and NPM and use prebuild binaries.
vim-doge-3.1.1.tar.gz	3.1.1	2020-10-13	7.4	Kim 金可明	Use !name instead of !parentName in JavaScript destructured function parameter expressions for the sake of multi-cursor usage.
vim-doge-3.1.0.tar.gz	3.1.0	2020-10-13	7.4	Kim 金可明	- Add new option to show/hide destructuring in docblocks for JavaScript filetypes. - Fix neovim parser error.
vim-doge-3.0.1.tar.gz	3.0.1	2020-10-08	7.4	Kim 金可明	- Make rimraf a dep instead of devDep to fix installation process - Remove types from python Google doc
vim-doge-3.0.0.tar.gz	3.0.0	2020-10-08	7.4	Kim 金可明	Rewrite vim-doge to use tree-sitter parsers.
vim-doge-2.8.0.tar.gz	2.8.0	2020-09-02	7.4	Kim 金可明	Add support for python async functions.
vim-doge-2.7.1.tar.gz	2.7.1	2020-08-14	7.4	Kim 金可明	Fix typescript bug multiline function declaration with decorators and deconstructuring.
vim-doge-2.7.0.tar.gz	2.7.0	2020-08-09	7.4	Kim 金可明	Add support for single-quotes in Python.
vim-doge-2.6.0.tar.gz	2.6.0	2020-07-25	7.4	Kim 金可明	Add proper support for advanced typescript syntax.
vim-doge-2.5.1.tar.gz	2.5.1	2020-07-25	7.4	Kim 金可明	Support exceptions in java method declaration along with @throws tag.
vim-doge-2.5.0.tar.gz	2.5.0	2020-07-13	7.4	Kim 金可明	Add new PHP features: - Transform ?Foo parameter type into Foo|null - Add whiteline in-between @param and @return tags - Add custom g:doge_php_settings = {'resolve_fqn': 1} to disable FQN resolving
vim-doge-2.4.3.tar.gz	2.4.3	2020-06-23	7.4	Kim 金可明	Add Outputs section to shell doc blocks.
vim-doge-2.4.2.tar.gz	2.4.2	2020-06-06	7.4	Kim 金可明	Do not pre-create and save the file after DogeCreateDocStandard.
vim-doge-2.4.1.tar.gz	2.4.1	2020-05-30	7.4	Kim 金可明	Allow default exports for JavaScript-like languages.
vim-doge-2.4.0.tar.gz	2.4.0	2020-05-30	7.4	Kim 金可明	Add support for TypeScript ES7 decorators.
vim-doge-2.3.0.tar.gz	2.3.0	2020-05-23	7.4	Kim 金可明	Add Promise<T> as a return type when a JavaScript function is async.
vim-doge-2.2.9.tar.gz	2.2.9	2020-05-15	7.4	Kim 金可明	Indent line based on current line rather than next or previous line.
vim-doge-2.2.8.tar.gz	2.2.8	2020-05-05	7.4	Kim 金可明	Improve the regular expression of the sh function.
vim-doge-2.2.7.tar.gz	2.2.7	2020-03-13	7.4	Kim 金可明	Preprocess aliased filetypes.
vim-doge-2.2.6.tar.gz	2.2.6	2020-03-07	7.4	Kim 金可明	Allow keyword arguments and functions without parentheses in Ruby.
vim-doge-2.2.5.tar.gz	2.2.5	2020-03-05	7.4	Kim 金可明	Order list in doge#buffer#get_supported_doc_standards() based on how it should be defined.
vim-doge-2.2.4.tar.gz	2.2.4	2020-02-21	7.4	Kim 金可明	Support JavaScript/TypeScript @generator tag and escape pipe characters in input to ensure union types are parsed correctly.
vim-doge-2.2.3.tar.gz	2.2.3	2020-02-19	7.4	Kim 金可明	Check whether current filetype is supported.
vim-doge-2.2.2.tar.gz	2.2.2	2020-02-18	7.4	Kim 金可明	Support advanced typescript parameters.
vim-doge-2.2.1.tar.gz	2.2.1	2020-02-18	7.4	Kim 金可明	Add check when switching from an alias ft to alias ft.
vim-doge-2.2.0.tar.gz	v2.2.0	2020-01-01	7.4	Kim 金可明	Add support for g:doge_filetype_aliases. Prevent patterns getting stacked when changing filetype.
vim-doge-2.1.0.tar.gz	v2.1.0	2019-12-28	7.4	Kim 金可明	Add support for PHP 7 return type declaration and PHP 8 union types.
vim-doge-2.0.0.tar.gz	v2.0.0	2019-12-28	7.4	Kim 金可明	Add support for custom doc standards.
vim-doge-1.17.5.tar.gz	1.17.5	2019-12-02	7.4	Kim 金可明	Allow protected and private function data modifier in JavaScript and TypeScript.
vim-doge-1.17.3.tar.gz	1.17.3	2019-11-28	7.4	Kim 金可明	Support optional parameter indicator for TypeScript class methods.
vim-doge-1.17.2.tar.gz	1.17.2	2019-11-26	7.4	Kim 金可明	Allow public keyword for JavaScript/TypeScript functions.
vim-doge-1.17.1.tar.gz	1.17.1	2019-11-25	7.4	Kim 金可明	Exclude self, cls and klass from python documentation.
vim-doge-1.17.0.tar.gz	1.17.0	2019-11-25	7.4	Kim 金可明	DogeGenerate accepts count/string as argument.
vim-doge-1.16.0.tar.gz	1.16.0	2019-11-19	7.4	Kim 金可明	Support Shell Script.
vim-doge-1.15.3.tar.gz	1.15.3	2019-11-19	7.4	Kim 金可明	Resolve conflict with romainl/vim-cool while jumping forward/backward.
vim-doge-1.15.2.tar.gz	1.15.2	2019-11-18	7.4	Kim 金可明	Allow libclang extra clang args via g:doge_clang_args option.
vim-doge-1.15.1.tar.gz	1.15.1	2019-11-18	7.4	Kim 金可明	Let libclang create temp file in same dir as current buffer to ensure parsing goes right.
vim-doge-1.15.0.tar.gz	1.15.0	2019-11-18	7.4	Kim 金可明	Add support for C and C++ using clang.
vim-doge-1.14.1.tar.gz	1.14.1	2019-11-18	7.4	Kim 金可明	Allow export keyword in front of variables for JavaScript.
vim-doge-1.14.0.tar.gz	1.14.0	2019-10-25	7.4	Kim 金可明	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 金可明	Prevent highlight flickering when jumping. Persist search history.
vim-doge-1.13.0.tar.gz	1.13.0	2019-09-12	7.4	Kim 金可明	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 金可明	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 金可明	Optimise comment generation for Java.
vim-doge-1.11.1.tar.gz	1.11.1	2019-07-30	8.0	Kim 金可明	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 金可明	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 金可明	Add the :DogeGenerate command to generate documentation.
vim-doge-1.9.3.tar.gz	1.9.3	2019-07-28	8.0	Kim 金可明	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 金可明	Filter out the self parameter in Python methods.
vim-doge-1.9.1.tar.gz	1.9.1	2019-07-28	8.0	Kim 金可明	Prevent indenting when empty line.
vim-doge-1.9.0.tar.gz	1.9.0	2019-07-27	8.0	Kim 金可明	Add support for JavaScript ES6 class properties.
vim-doge-1.8.2.tar.gz	1.8.2	2019-07-27	8.0	Kim 金可明	Remove additional whiteline after javascript main function description.
vim-doge-1.8.1.tar.gz	1.8.1	2019-07-27	8.0	Kim 金可明	Use correct phpdoc description format for PHP.
vim-doge-1.8.0.tar.gz	1.8.0	2019-07-27	8.0	Kim 金可明	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 金可明	Add javascript/typescript pattern for functions inside objects.
vim-doge-1.6.1.tar.gz	1.6.1	2019-07-27	8.0	Kim 金可明	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 金可明	Add TODO contexts for every language.
vim-doge-1.5.3.tar.gz	1.5.3	2019-07-27	8.0	Kim 金可明	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 金可明	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 金可明	Fix python google style return type position.
vim-doge-1.5.0.tar.gz	1.5.0	2019-07-27	8.0	Kim 金可明	Add Sphinx doc standard for Python.
vim-doge-1.4.7.tar.gz	1.4.7	2019-07-27	8.0	Kim 金可明	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 金可明	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 金可明	Allow dot-characters in python parameter type hint.
vim-doge-1.4.4.tar.gz	1.4.4	2019-07-18	8.0	Kim 金可明	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 金可明	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 金可明	Remove <unique> to fix mapping-already-exists error.
vim-doge-1.4.1.tar.gz	1.4.1	2019-07-18	8.0	Kim 金可明	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 金可明	Support TODO contexts.
vim-doge-1.3.2.tar.gz	1.3.2	2019-07-18	8.0	Kim 金可明	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 金可明	Fix catch statements for different locales.
vim-doge-1.3.0.tar.gz	1.3.0	2019-07-13	8.0	Kim 金可明	Add support for Google styleguide doc for Python.
vim-doge-1.2.3.tar.gz	1.2.3	2019-07-13	8.0	Kim 金可明	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 金可明	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 金可明	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 金可明	Add support for C++.
vim-doge-1.1.0.tar.gz	1.1.0	2019-06-29	8.0	Kim 金可明	Add support for multiple doc standard per filetype.
vim-doge-1.0.0.tar.gz	1.0.0	2019-06-25	8.0	Kim 金可明	Initial upload

ip used for rating: 3.145.52.86