Skip to content

vim-patch:910bfd5: runtime(java): Consent to HTML tags folding in Javadoc comments #33718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2025
+28 −1
Merged

vim-patch:910bfd5: runtime(java): Consent to HTML tags folding in Javadoc comments #33718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions runtime/doc/syntax.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1689,6 +1689,13 @@ line for any comments written in this way, and showing the contents of a first
line otherwise, with >
:let g:java_foldtext_show_first_or_second_line = 1
HTML tags in Javadoc comments can additionally be folded by following the
instructions listed under |html-folding| and giving explicit consent with >
:let g:java_consent_to_html_syntax_folding = 1
Do not default to this kind of folding unless ALL start tags and optional end
tags are balanced in Javadoc comments; otherwise, put up with creating runaway
folds that break syntax highlighting.

Trailing whitespace characters or a run of space characters before a tab
character can be marked as an error with >
:let g:java_space_errors = 1
Expand Down
22 changes: 21 additions & 1 deletion runtime/syntax/java.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
" Maintainer: Aliaksei Budavei <0x000c70 AT gmail DOT com>
" Former Maintainer: Claudio Fleiner <claudio@fleiner.com>
" Repository: https://github.com/zzzyxwvut/java-vim.git
" Last Change: 2025 Mar 26
" Last Change: 2025 Apr 28

" Please check ":help java.vim" for comments on some of the options
" available.
Expand Down Expand Up @@ -387,15 +387,30 @@ if !exists("g:java_ignore_javadoc") && (s:with_html || s:with_markdown) && g:mai
" Include HTML syntax coloring for Javadoc comments.
if s:with_html
try
if exists("g:html_syntax_folding") && !exists("g:java_consent_to_html_syntax_folding")
let s:html_syntax_folding_copy = g:html_syntax_folding
unlet g:html_syntax_folding
endif

syntax include @javaHtml syntax/html.vim
finally
unlet! b:current_syntax

if exists("s:html_syntax_folding_copy")
let g:html_syntax_folding = s:html_syntax_folding_copy
unlet s:html_syntax_folding_copy
endif
endtry
endif

" Include Markdown syntax coloring (v7.2.437) for Javadoc comments.
if s:with_markdown
try
if exists("g:html_syntax_folding") && !exists("g:java_consent_to_html_syntax_folding")
let s:html_syntax_folding_copy = g:html_syntax_folding
unlet g:html_syntax_folding
endif

syntax include @javaMarkdown syntax/markdown.vim

try
Expand All @@ -413,6 +428,11 @@ if !exists("g:java_ignore_javadoc") && (s:with_html || s:with_markdown) && g:mai
finally
unlet! b:current_syntax

if exists("s:html_syntax_folding_copy")
let g:html_syntax_folding = s:html_syntax_folding_copy
unlet s:html_syntax_folding_copy
endif

if exists("s:no_support")
unlet s:no_support
unlockvar s:with_markdown
Expand Down
Loading