Add @commands, @functions, @options
authorGreg Hurrell <greg@hurrell.net>
Thu, 30 Jul 2015 14:18:05 +0000 (07:18 -0700)
committerGreg Hurrell <greg@hurrell.net>
Thu, 30 Jul 2015 14:18:05 +0000 (07:18 -0700)
For the same reason that @mappings is useful, we want a way to
supplement the auto-generated COMMANDS, FUNCTIONS and OPTIONS sections
with arbitrary additional info.

For now this info will get appended to the section, but in the future I
might look at providing nested @header and @footer annotations to allow
you to force it to one location of the other; eg:

  @commands

  @header

  Stuff that gets prepended to the COMMANDS section.

  @footer

  Stuff that gets appended to the COMMANDS section.

after/syntax/vim.vim

index c8996de866fac8f556f8cc089d3ed7304ccf9e01..7bae35aed661b91fee67aaf593325cfe288da455 100644 (file)
@@ -153,13 +153,16 @@ syntax region docvimBlock start='\v^\s*""' end='\v^\zs\ze\s*($|[^ \t"])' contain
 syntax region docvimPre start='\v^\s*"\s+\zs```\s*$' end='\v^\s*"\s+```\s*$' containedin=docvimBlock contained keepend
 
 syntax match docvimAnnotation '\v\@command( .+)?' containedin=docvimBlock contained
+syntax match docvimAnnotation '@commands' containedin=docvimBlock contained
 syntax match docvimAnnotation '@dedent' containedin=docvimBlock contained
 syntax match docvimAnnotation '@footer' containedin=docvimBlock contained
 syntax match docvimAnnotation '\v\@function( .+)?' containedin=docvimBlock contained
+syntax match docvimAnnotation '@functions' containedin=docvimBlock contained
 syntax match docvimAnnotation '@indent' containedin=docvimBlock contained
 syntax match docvimAnnotation '\v\@mapping( .+)?' containedin=docvimBlock contained
 syntax match docvimAnnotation '@mappings' containedin=docvimBlock contained
 syntax match docvimAnnotation '\v\@option( .+)?' containedin=docvimBlock contained
+syntax match docvimAnnotation '@options' containedin=docvimBlock contained
 syntax match docvimAnnotation '@param' containedin=docvimBlock contained
 syntax match docvimAnnotation '\v\@plugin( .+)?' containedin=docvimBlock contained
 syntax match docvimAnnotation '@private' containedin=docvimBlock contained