sponsor Vim development Vim logo Vim Book Ad

MakeDoxygenComment : Generate Doxygen Comment Skeleton

 script karma  Rating 95/45, Downloaded by 3633    Comments, bugs, improvements  Vim wiki

created by
Leif Wickland
 
script type
ftplugin
 
description
I haven't maintained this in a long time.  I'd suggest trying out Ryan De Boer's updated version: vimscript #4530.

Generates a doxygen comment skeleton for a C, C++,  or Java function, including @brief, @param (for each named argument), and @return.  The tag text as well as a comment block header and footer are configurable.  (Consequently, you can have \brief, etc. if you wish, with little effort.)

It's definitely a little rough around the edges, but I hope you find it useful.

To use:  In vim with the cursor on the line of the function header that contains the parameters (if any), execute the command :Dox.  This will generate the skeleton and leave the cursor after the @brief tag.

Limitations:
Assumes that the function has a blank line above it and that all of the parameters are on the same line.  
Not able to update a comment block after it's been written.
Writes the @return tag for a void function.

Example:
Given:
int foo(char mychar, int yourint, double myarray[])
{ //...
}

Issuing the :Dox command with the cursor on the function declaration would generate

/**
* @brief
*
* @param mychar
* @param myint
* @param myarray
*
* @returns
**/
 
install details
Stick MakeDoxygenComment.vim in either your plugins or ftplugins/* directory.
 

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
MakeDoxygenComment.vim 0.1.3 2004-03-01 6.0 Leif Wickland Now correctly recognizes parameters which end in '[]'.
MakeDoxygenComment.vim 0.1.2 2004-02-23 6.0 Leif Wickland Fixed a problem with whitespace between the identifier and the ',' or ')'.  (Thanks to Mirko Koenig.)
MakeDoxygenComment.vim 0.1.1 2003-06-12 6.0 Leif Wickland Minor bug fix
MakeDoxygenComment.vim 0.1 2003-06-12 6.0 Leif Wickland Initial upload
ip used for rating: 54.83.167.152

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