0020 - jcommenter.vim.json

{
  "script_id": "20",
  "display_name": "jcommenter.vim",
  "summary": "A script for automatically generating JavaDoc comments",
  "name": "jcommenter.vim",
  "script_type": "utility",
  "description": "Updated 29.12.2002 KB\n\nDescription:\nGenerates JavaDoc (and some other) comments for java-sources. This is triggered by executing the JCommentWriter()-function while the cursor is over something meaningfull, or if a selection exists, the selected text is parsed and the comment template is generated based on that.\n\nThe following comments are generated (in the appropriate situations):\n1. File comments: user specifies the template, generated when the cursor is on the first line of the file.\n2. Class comments: generated when on top of a class declaration\n3. Method comments: generated when on top of a metod declaration. @return, @params, and @throws are generated, if applicable. If executed on a method declaration which already has JavaDoc-comments, updates the javadoc-comments by removing/adding tags as needed.\n4.  Field comments. Simply adds an empty JavaDoc-comment template above the field declaration\n5. Copy @<name> -tags. When executed on @something, creates a tag with the same name directly above the line the cursor is currently on.\n6. @throws for RuntimeExceptions. When executed on a line containing something like \"throw new RuntimeException()\", a @throws-tag is added to the previous JavaDoc-comment.\n7. Block-end comments. When executed on a line containing a '}'-character and possibly some whitespace (but nothing else), generates a one-line-comment describing what block the '}' is terminating. For example, the comment for \"aVeryLongMethod\" is  \"// END: aVeryLongMethod\".\n\nThere are a bunch of other functions to support the comment generation (see the start of the script for full documentation). The style of the comment templates is configurable (see the file for configuration and description of the options)",
  "install_details": "Add the jcommenter.vim to your macros-folder (or whatever).\nHere's what I have in my .vimrc:\n\n  autocmd FileType java let b:jcommenter_class_author='Kalle Björklid (bjorklid@st.jyu.fi)'\n  autocmd FileType java let b:jcommenter_file_author='Kalle Björklid (bjorklid@st.jyu.fi)'\n  autocmd FileType java source $VIM/macros/jcommenter.vim\n  autocmd FileType java map <M-c> :call JCommentWriter()<CR>\n\nSo I use Alt-c for commenting the file/methods/attributes/classes.",
  "versions": [
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=1587",
      "filename": "jcommenter.vim",
      "script_version": "1.3.1",
      "date": "2002-12-29",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Fixed two bugs concerning the modifications for 1.3"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=1586",
      "filename": "jcommenter.vim",
      "script_version": "1.3",
      "date": "2002-12-29",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Added check to see whether the script is already loaded\nOption to have an empty line automatically added before the generated comment if there was none previously. See config (\"b:jcommenter_add_empty_line\").\n"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=371",
      "filename": "jcommenter.vim",
      "script_version": "1.2.1",
      "date": "2001-11-25",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Added support for generating modelines.\nUser requests:\nAdded possibility to have default tag values.\nAdded possibility to have space between tag groups."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=302",
      "filename": "jcommenter.vim",
      "script_version": "1.2",
      "date": "2001-10-24",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "A bunch of new features (some seem to be actually useful ;-) :\nComplete method comment updating: now adds/removes @return- and @param-tags form existing doc comments if no more applicable.\nAdded a new public function (+ mappings for it) for searching incomplete doc-comments (This is nice - a quick way to complete comments and to jump to next incomplete comment)\nIf executed on a line like \"throw new RuntimeExeception()\" will add an exception declaration to prev. javadoc comments.\nCorrected a problem where updating didn't work if a new parameter's name began the same way than an existing one's.\nNow behaves correctly when \"extra stuff\" (after the '{') is included in the range.\nAdded mapping for insert-mode to config-file.\nAdded an abbreviation (see config-file)\nNow adds the method/class/if/while/for... name as an ending comment when executed on a line containing only whitespace and a '}'.\nComment generation can now be virtually fully automated by using an abbreviation for '{' (which is presented in the config-file)."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=278",
      "filename": "jcommenter.vim",
      "script_version": "1.12",
      "date": "2001-10-16",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Fixed a problem which caused all methods to be interperted as constructors (no @return-tag generated)."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=105",
      "filename": "jcommenter.vim",
      "script_version": "1.11",
      "date": "2001-08-14",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Fixed an error concerning the removal of the return tag when updating the comments (the buffer was partially deleted from the line where the @return tag was to EOF)"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=101",
      "filename": "jcommenter.vim",
      "script_version": "1.1",
      "date": "2001-08-12",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "This is again a .vim file (and not a zip). The configuration file is pasted at the beginning of the script. Again, see the script\nfor instructions.\n\nCan now choose between '@throws' and '@exception' tags.\nWhen executed on single-line comments (\"/** blah blah */\") expands them into multiline comments preserving the text\nPartial method documentation comment updating (adds tags instead of writing a new template)"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=97",
      "filename": "jcommenter.vim",
      "script_version": "1.0",
      "date": "2001-08-11",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "A note:\nsince there was two files in this version of the script, I zipped them. However, if you download the file, it has .vim-extension, so you have to rename it.\nI'm really sorry for the inconvience."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=96",
      "filename": "jcommenter.vim",
      "script_version": "1.0",
      "date": "2001-08-11",
      "vim_version": "6.0",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Did a complete rewrite of the script-code (this is the main reason for the version-number leap).\nA separate config-file, which should be modified to reflect the user's preferences.\nMore variables for better customization.\nDue to the rewrite, should now be more robust\nCursor movement and auto-start insert mode\nBetter control over the look of the comment templates\n\nRead new installation and configuration instructions from the .vim files"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=47",
      "filename": "jcommenter.vim",
      "script_version": "0.41",
      "date": "2001-07-15",
      "vim_version": "5.7",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Fixed the problem with final method parameters."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=39",
      "filename": "jcommenter.vim",
      "script_version": "0.4",
      "date": "2001-07-06",
      "vim_version": "5.7",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Recognizes now methods that have whitespaces just before the '('.\nThe file comments can now be completely redefined without editing the script.\nThe comment-skeleton for fields is changed to correspond with the Sun's code conventions."
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=27",
      "filename": "jcommenter.vim",
      "script_version": "0.3",
      "date": "2001-06-17",
      "vim_version": "5.7",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "- Recognices interfaces (same as classes)\n- improved recognition for methods/attributes\n- Added tag copying:\n   For example, when executed on the following line:\n      * @throws IOException If cannot read file\n   the result is:\n      * @throws IOException If cannot read file\n      * @throws\n   Not that life changing, but quite nice when you want to document those\n   RuntimeExceptions, or need to add another paramter.\n"
    },
    {
      "url": "http://www.vim.org/scripts/download_script.php?src_id=25",
      "filename": "jcommenter.vim",
      "script_version": "0.2 beta",
      "date": "2001-06-13",
      "vim_version": "5.7",
      "author": {
        "user_id": "53",
        "user_name": "bjorklid",
        "first_name": "Kalle",
        "last_name": "Björklid",
        "email": "bjorklid@st.jyu.fi",
        "homepage": ""
      },
      "release_notes": "Initial upload"
    }
  ]
}