-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
130 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| " ============================================================================== | ||
| " The C documentation should follow the 'Doxygen' conventions. | ||
| " see http://www.doxygen.nl/manual/docblocks.html | ||
| " ============================================================================== | ||
|
|
||
| let s:save_cpo = &cpoptions | ||
| set cpoptions&vim | ||
|
|
||
| let b:doge_pattern_single_line_comment = '\m\(\/\*.\{-}\*\/\|\/\/.\{-}$\)' | ||
| let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/' | ||
|
|
||
| let b:doge_supported_doc_standards = [ | ||
| \ 'doxygen_javadoc', | ||
| \ 'doxygen_javadoc_no_asterisk', | ||
| \ 'doxygen_javadoc_banner', | ||
| \ 'doxygen_qt', | ||
| \ 'doxygen_qt_no_asterisk', | ||
| \ 'kernel_doc' | ||
| \ ] | ||
| let b:doge_doc_standard = get(g:, 'doge_doc_standard_c', b:doge_supported_doc_standards[0]) | ||
| if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0 | ||
| echoerr printf( | ||
| \ '[DoGe] %s is not a valid C doc standard, available doc standard are: %s', | ||
| \ b:doge_doc_standard, | ||
| \ join(b:doge_supported_doc_standards, ', ') | ||
| \ ) | ||
| endif | ||
|
|
||
| let b:doge_patterns = [] | ||
|
|
||
| call add(b:doge_patterns, { | ||
| \ 'generator': 'libclang.py', | ||
| \ 'parameters': { | ||
| \ 'format': { | ||
| \ 'doxygen_javadoc': '@{param-type|param} {name} !description', | ||
| \ 'doxygen_javadoc_no_asterisk': '@{param-type|param} {name} !description', | ||
| \ 'doxygen_javadoc_banner': '@{param-type|param} {name} !description', | ||
| \ 'doxygen_qt': '@{param-type|param} {name} !description', | ||
| \ 'doxygen_qt_no_asterisk': '@{param-type|param} {name} !description', | ||
| \ 'kernel_doc': '@{param-type|param} {name} !description', | ||
| \ }, | ||
| \ }, | ||
| \ 'comment': { | ||
| \ 'insert': 'above', | ||
| \ 'template': { | ||
| \ 'doxygen_javadoc': [ | ||
| \ '/**', | ||
| \ ' * @brief !description', | ||
| \ ' *', | ||
| \ '%(parameters| * {parameters})%', | ||
| \ '%(returnType| * @return !description)%', | ||
| \ ' */', | ||
| \ ], | ||
| \ 'doxygen_javadoc_no_asterisk': [ | ||
| \ '/**', | ||
| \ '@brief !description', | ||
| \ '', | ||
| \ '%(parameters|{parameters})%', | ||
| \ '%(returnType|@return !description)%', | ||
| \ '*/', | ||
| \ ], | ||
| \ 'doxygen_javadoc_banner': [ | ||
| \ '/*******************************************************************************', | ||
| \ ' * @brief !description', | ||
| \ ' *', | ||
| \ '%(parameters| * {parameters})%', | ||
| \ '%(returnType| * @return !description)%', | ||
| \ ' ******************************************************************************/', | ||
| \ ], | ||
| \ 'doxygen_qt': [ | ||
| \ '/*!', | ||
| \ ' * @brief !description', | ||
| \ ' *', | ||
| \ '%(parameters| * {parameters})%', | ||
| \ '%(returnType| * @return !description)%', | ||
| \ ' */', | ||
| \ ], | ||
| \ 'doxygen_qt_no_asterisk': [ | ||
| \ '/*!', | ||
| \ '@brief !description', | ||
| \ '', | ||
| \ '%(parameters|{parameters})%', | ||
| \ '%(returnType|@return !description)%', | ||
| \ '*/', | ||
| \ ], | ||
| \ 'kernel_doc': [ | ||
| \ '/**', | ||
| \ ' * {funcName}(): !description', | ||
| \ '%(parameters| * {parameters})%', | ||
| \ ' *', | ||
| \ ' * !description', | ||
| \ ' *', | ||
| \ '%(returnType| * Return: !description)%', | ||
| \ ' */', | ||
| \ ], | ||
| \ }, | ||
| \ }, | ||
| \}) | ||
|
|
||
| let &cpoptions = s:save_cpo | ||
| unlet s:save_cpo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /** | ||
| * add(): [TODO:description] | ||
| * @param x [TODO:description] | ||
| * @param y [TODO:description] | ||
| * | ||
| * [TODO:description] | ||
| * | ||
| * Return: [TODO:description] | ||
| */ | ||
| int add(int x, int y) {} |