xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rc: Highlight embedded documentation

Browse Source 
This commit adds a `documentation` face to the builtin themes, used
to highlight common documentation syntaxes:

	/**
	 * JavaDoc
	 */

	/*!
	 * QtDoc
	 */

	/// Inline documentation

	## Inline documentation

The face is only an alias to the `comment` one for now.

Closes #1944
This commit is contained in:
Frank LENORMAND 2018-06-23 08:38:46 +03:00
parent 2749093143
commit 0c4c744362
25 changed files with 78 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
colors/base16.kak
View File

@ -28,6 +28,7 @@ evaluate-commands %sh{
face global operator ${cyan_light}
face global attribute ${orange_dark}
face global comment ${grey_dark}
face global documentation comment
face global meta ${orange_light}
face global builtin default+b
"

1
colors/default.kak
View File

@ -11,6 +11,7 @@ face global keyword blue
face global operator yellow
face global attribute green
face global comment cyan
face global documentation comment
face global meta magenta
face global builtin default+b

19
colors/desertex.kak
View File

@ -1,15 +1,16 @@
# desertex theme
# Code
face global value rgb:fa8072
face global type rgb:dfdfbf
face global identifier rgb:87ceeb
face global string rgb:fa8072
face global error rgb:c3bf9f+b
face global keyword rgb:eedc82
face global operator rgb:87ceeb
face global attribute rgb:eedc82
face global comment rgb:7ccd7c+i
face global value rgb:fa8072
face global type rgb:dfdfbf
face global identifier rgb:87ceeb
face global string rgb:fa8072
face global error rgb:c3bf9f+b
face global keyword rgb:eedc82
face global operator rgb:87ceeb
face global attribute rgb:eedc82
face global comment rgb:7ccd7c+i
face global documentation comment
# #include <...>
face global meta rgb:ee799f

1
colors/github.kak
View File

@ -14,6 +14,7 @@ face global keyword rgb:A71D5D+b
face global operator yellow
face global attribute rgb:A71D5D
face global comment rgb:AAAAAA
face global documentation comment
face global meta rgb:183691
face global builtin default+b

1
colors/greyscale.kak
View File

@ -24,6 +24,7 @@ evaluate-commands %sh{
set-face global builtin ${grey}+b
set-face global module ${grey_dark_1}
set-face global comment ${grey}+i
set-face global documentation comment
set-face global function Default
set-face global operator Default
set-face global variable Default

25
colors/gruvbox.kak
View File

@ -24,18 +24,19 @@ evaluate-commands %sh{
echo "
# Code highlighting
face global value ${purple}
face global type ${yellow}
face global variable ${blue}
face global module ${green}
face global function ${fg}
face global string ${green}
face global keyword ${red}
face global operator ${fg}
face global attribute ${orange}
face global comment ${gray}+i
face global meta ${aqua}
face global builtin ${fg}+b
face global value ${purple}
face global type ${yellow}
face global variable ${blue}
face global module ${green}
face global function ${fg}
face global string ${green}
face global keyword ${red}
face global operator ${fg}
face global attribute ${orange}
face global comment ${gray}+i
face global documentation comment
face global meta ${aqua}
face global builtin ${fg}+b
# Markdown highlighting
face global title ${green}+b

3
colors/kaleidoscope-dark.kak
View File

@ -1,4 +1,4 @@
# Kaleidoscope: colorblind-friendly light colorscheme
# Kaleidoscope: colorblind-friendly dark colorscheme
# https://personal.sron.nl/~pault/
evaluate-commands %sh{
@ -82,6 +82,7 @@ evaluate-commands %sh{
set-face global builtin ${vibrant_blue}+b
set-face global module ${vibrant_orange}
set-face global comment ${bright_green}+i
set-face global documentation comment
set-face global function Default
set-face global operator Default
set-face global variable Default

1
colors/kaleidoscope-light.kak
View File

@ -82,6 +82,7 @@ evaluate-commands %sh{
set-face global builtin ${muted_indigo}+b
set-face global module ${vibrant_orange}
set-face global comment ${muted_green}+i
set-face global documentation comment
set-face global function Default
set-face global operator Default
set-face global variable Default

1
colors/lucius.kak
View File

@ -34,6 +34,7 @@ evaluate-commands %sh{
face global operator ${lucius_green}
face global attribute ${lucius_light_blue}
face global comment ${lucius_grey}
face global documentation comment
face global meta ${lucius_purple}
face global builtin default+b

23
colors/palenight.kak
View File

@ -25,17 +25,18 @@ evaluate-commands %sh{
printf "%s\n" "
# Code
face global value $dark_yellow
face global type $yellow
face global function $blue
face global variable $blue
face global identifier $blue
face global string $green
face global error rgb:c3bf9f+b
face global keyword $purple
face global operator $cyan
face global attribute rgb:eedc82
face global comment $comment_grey+i
face global value $dark_yellow
face global type $yellow
face global function $blue
face global variable $blue
face global identifier $blue
face global string $green
face global error rgb:c3bf9f+b
face global keyword $purple
face global operator $cyan
face global attribute rgb:eedc82
face global comment $comment_grey+i
face global documentation comment
# #include <...>
face global meta $yellow

1
colors/plain.kak
View File

@ -9,6 +9,7 @@ face global keyword default
face global operator default
face global attribute default
face global comment blue
face global documentation comment
face global meta default
face global builtin default

1
colors/red-phoenix.kak
View File

@ -43,6 +43,7 @@ evaluate-commands %sh{
face global operator ${yellow1}
face global attribute ${tan1}
face global comment ${gray1}
face global documentation comment
face global meta ${gray2}
face global builtin ${tan1}
"

25
colors/reeder.kak
View File

@ -22,18 +22,19 @@ evaluate-commands %sh{
# Base color definitions
echo "
# then we map them to code
face global value ${orange_light}+b
face global type ${orange}
face global variable default
face global module ${green}
face global function default
face global string ${green}
face global keyword ${brown_dark}
face global operator default
face global attribute ${green}
face global comment ${brown_light}
face global meta ${brown_dark}
face global builtin default+b
face global value ${orange_light}+b
face global type ${orange}
face global variable default
face global module ${green}
face global function default
face global string ${green}
face global keyword ${brown_dark}
face global operator default
face global attribute ${green}
face global comment ${brown_light}
face global documentation comment
face global meta ${brown_dark}
face global builtin default+b
# and markup
face global title ${orange}+b

1
colors/solarized-dark-termcolors.kak
View File

@ -12,6 +12,7 @@ face global keyword green
face global operator green
face global attribute bright-magenta
face global comment bright-green
face global documentation comment
face global meta bright-red
face global builtin default+b

1
colors/solarized-dark.kak
View File

@ -30,6 +30,7 @@ evaluate-commands %sh{
face global operator ${yellow}
face global attribute ${violet}
face global comment ${base01}
face global documentation comment
face global meta ${orange}
face global builtin default+b

1
colors/solarized-light-termcolors.kak
View File

@ -12,6 +12,7 @@ face global keyword green
face global operator yellow
face global attribute bright-magenta
face global comment bright-cyan
face global documentation comment
face global meta bright-red
face global builtin default+b

1
colors/solarized-light.kak
View File

@ -30,6 +30,7 @@ evaluate-commands %sh{
face global operator ${yellow}
face global attribute ${violet}
face global comment ${base1}
face global documentation comment
face global meta ${orange}
face global builtin default+b

1
colors/tomorrow-night.kak
View File

@ -33,6 +33,7 @@ evaluate-commands %sh{
face global operator ${aqua}
face global attribute ${purple}
face global comment ${comment}
face global documentation comment
face global meta ${purple}
face global builtin ${orange}
"

1
colors/zenburn.kak
View File

@ -41,6 +41,7 @@ evaluate-commands %sh{
face global operator ${zenfunction}
face global attribute ${zenstatement}
face global comment ${zencomment}
face global documentation comment
face global meta ${zenspecial}
face global builtin default+b

4
rc/filetype/c-family.kak
View File

@ -198,6 +198,10 @@ evaluate-commands %sh{
add-highlighter shared/$ft/code default-region group
add-highlighter shared/$ft/string region %{$maybe_at(?<!')(?<!'\\\\)"} %{(?<!\\\\)(?:\\\\\\\\)*"} fill string
add-highlighter shared/$ft/raw_string region -match-capture %{R"([^(]*)\\(} %{\\)([^")]*)"} fill string
add-highlighter shared/$ft/javadoc region /\*\* \*/ fill documentation
add-highlighter shared/$ft/qtdoc region /\*! \*/ fill documentation
add-highlighter shared/$ft/inline_doc region /// $ fill documentation
add-highlighter shared/$ft/inline_qtdoc region //! $ fill documentation
add-highlighter shared/$ft/comment region /\\* \\*/ fill comment
add-highlighter shared/$ft/line_comment region // (?<!\\\\)(?=\\n) fill comment
add-highlighter shared/$ft/disabled region -recurse "#\\h*if(?:def)?" ^\\h*?#\\h*if\\h+(?:0|FALSE)\\b "#\\h*(?:else|elif|endif)" fill comment

6
rc/filetype/d.kak
View File

@ -40,12 +40,12 @@ add-highlighter shared/d/code default-region group
add-highlighter shared/d/string region %{(?<!')(?<!'\\)"} %{(?<!\\)(?:\\\\)*"} group
add-highlighter shared/d/verbatim_string region %{(?<!')(?<!'\\)`} %{(?<!\\)(?:\\\\)*`} fill meta
add-highlighter shared/d/verbatim_string_prefixed region %{r`([^(]*)\(} %{\)([^)]*)`} fill meta
add-highlighter shared/d/docstring1 region '/\+\+' '\+/' fill documentation
add-highlighter shared/d/docstring2 region '/\*\*' '\*/' fill documentation
add-highlighter shared/d/docstring3 region /// $ fill documentation
add-highlighter shared/d/disabled region '/\+[^+]?' '\+/' fill comment
add-highlighter shared/d/comment1 region '/\*[^*]?' '\*/' fill comment
add-highlighter shared/d/comment2 region '//[^/]?' $ fill comment
add-highlighter shared/d/docstring1 region '/\+\+' '\+/' fill comment
add-highlighter shared/d/docstring2 region '/\*\*' '\*/' fill comment
add-highlighter shared/d/docstring3 region /// $ fill comment
add-highlighter shared/d/string/ fill string
add-highlighter shared/d/string/ regex %{\\(x[0-9a-fA-F]{2}|[0-7]{1,3}|u[0-9a-fA-F]{4}|U[0-9a-fA-F]{8})\b} 0:value

2
rc/filetype/java.kak
View File

@ -22,13 +22,13 @@ hook -group java-highlight global WinSetOption filetype=java %{
hook -once -always window WinSetOption filetype=.* %{ remove-highlighter window/java }
}
provide-module java %§
add-highlighter shared/java regions
add-highlighter shared/java/code default-region group
add-highlighter shared/java/string region %{(?<!')"} %{(?<!\\)(\\\\)*"} fill string
add-highlighter shared/java/comment region /\* \*/ fill comment
add-highlighter shared/java/inline_documentation region /// $ fill documentation
add-highlighter shared/java/line_comment region // $ fill comment
add-highlighter shared/java/code/ regex %{\b(this|true|false|null)\b} 0:value

6
rc/filetype/nim.kak
View File

@ -38,8 +38,10 @@ add-highlighter shared/nim/code default-region group
add-highlighter shared/nim/triple_string region '([A-Za-z](_?\w)*)?"""' '"""(?!")' fill string
add-highlighter shared/nim/raw_string region [A-Za-z](_?[A-Za-z])*" (?<!")"(?!") fill string
add-highlighter shared/nim/string region (?<!'\\)" ((?<!\\)(\\\\)*"|$) group
add-highlighter shared/nim/comment region '#?#\[' '\]##?' group
add-highlighter shared/nim/comment_line region (?<![^'].')#?#(?!'\[) $ group
add-highlighter shared/nim/inline_documentation region '##' $ fill documentation
add-highlighter shared/nim/documentation region '##\[' '\]##' fill documentation
add-highlighter shared/nim/comment region '#\[' '\]#' group
add-highlighter shared/nim/comment_line region (?<![^'].')#(?!'\[) $ group
add-highlighter shared/nim/string/fill fill string
add-highlighter shared/nim/comment/fill fill comment

1
rc/filetype/python.kak
View File

@ -37,6 +37,7 @@ add-highlighter shared/python/code default-region group
add-highlighter shared/python/docstring region -match-capture ("""|''') ("""|''') regions
add-highlighter shared/python/double_string region '"' (?<!\\)(\\\\)*" fill string
add-highlighter shared/python/single_string region "'" (?<!\\)(\\\\)*' fill string
add-highlighter shared/python/documentation region '##' '$' fill documentation
add-highlighter shared/python/comment region '#' '$' fill comment
# Integer formats

1
rc/filetype/rust.kak
View File

@ -35,6 +35,7 @@ add-highlighter shared/rust/code default-region group
add-highlighter shared/rust/string region %{(?<!')"} (?<!\\)(\\\\)*" fill string
add-highlighter shared/rust/raw_string region -match-capture %{(?<!')r(#*)"} %{"(#*)} fill string
add-highlighter shared/rust/comment region -recurse "/\*" "/\*" "\*/" fill comment
add-highlighter shared/rust/documentation region "//[!/]" "$" fill documentation
add-highlighter shared/rust/line_comment region "//" "$" fill comment
add-highlighter shared/rust/macro_attributes region -recurse "\[" "#!?\[" "\]" regions