.--.                 .-. .-.      .-.
     / .-_\_  ___     ___  | | | | ___  | |
    | | |___|/ o \  ,'_  | | '-' |/ o \ | | .--.
     \ '-'|   \  '.| | | | | .-. | \  '.| | | o |
      '---'    '--''-' '-' '-' '-'  '--''--'| |'
                                            | |
                                            '-'

** genhelp.vim -- Helper script to generate vim help files **

License:     GPLv3
Last Change: 2019-07-01

GenHelp generate vim help file for the current script.

HOW TO USE IT ?

:GenHelp Generate an help file from the current file. Tag file will be written once the file is saved.

:GenReadme Generate a simple readme from the current file.

WHAT I HAVE TO DO BEFORE ?

To work with GenHelp, the vim script format shall be the following :

" filename -- desc
" @Author:      author
" @License:     licence
" @Created:     creation-date
" @Last Change: modification-date
" @Revision:    revision
" @Files
"  ../plugin/file.vim
"  ../autoload/file.vim
"
" @AsciiArt
" text
"
" @Overview
" text

" Following properties can be located in any '@include' files
" @Examples
" text :  "     _codeblock_ "
" @Fileformat g:variablename
" text
" @global g:variablename
" text
" @function functionname(arguments)
" text
" @command commandname arguments
" text
" @usage usecase
" text
" @mapping keys
" text