]> git.ipfire.org Git - thirdparty/vim.git/commit
runtime(java): Recognise the CommonMark form (///) of Javadoc comments
authorAliaksei Budavei <0x000c70@gmail.com>
Mon, 30 Sep 2024 17:40:04 +0000 (19:40 +0200)
committerChristian Brabandt <cb@256bit.org>
Mon, 30 Sep 2024 17:40:04 +0000 (19:40 +0200)
commit85f054aa3f0fb9530712d0897e3c8ba29946fad4
treeb9e259059b42d35419236b01c537d1d557673a3f
parentde6c1d1182076b10212342fd2d441267fbe43a22
runtime(java): Recognise the CommonMark form (///) of Javadoc comments

Complement "g:java_ignore_javadoc" with "g:java_ignore_html"
and "g:java_ignore_markdown" to allow selectively disabling
the recognition of HTML and CommonMark respectively.

(Note that this is not a preview feature.)

======================== LIMITATION ========================

According to the syntactical details of JEP 467:

> Any leading whitespace and the three initial / characters
> are removed from each line.
>
> The lines are shifted left, by removing leading whitespace
> characters, until the non-blank line with the least
> leading whitespace has no remaining leading whitespace.
>
> Additional leading whitespace and any trailing whitespace
> in each line is preserved, because it may be significant.

the following example:
------------------------------------------------------------
///    A summary sentence.
///     A list:
///      - Item A.
///     - Item B.
///
///     Some code span, starting here `
///      1 + 2 ` and ending at the previous \`.
------------------------------------------------------------

should be interpreted as if it were written thus:
------------------------------------------------------------
///A summary sentence.
/// A list:
///  - Item A.
/// - Item B.
///
/// Some code span, starting here `
///  1 + 2 ` and ending at the previous \`.
------------------------------------------------------------

Since automatic line rewriting will not be pursued, parts of
such comments having significant whitespace may be ‘wrongly’
highlighted.  For convenience, a &fex function is defined to
‘correct’ it: g:javaformat#RemoveCommonMarkdownWhitespace()
(:help ft-java-plugin).

References:
https://openjdk.org/jeps/467
https://spec.commonmark.org/0.31.2

closes: #15740

Co-authored-by: Tim Pope <code@tpope.net>
Signed-off-by: Aliaksei Budavei <0x000c70@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
28 files changed:
runtime/autoload/javaformat.vim [new file with mode: 0644]
runtime/doc/filetype.txt
runtime/doc/syntax.txt
runtime/ftplugin/java.vim
runtime/syntax/java.vim
runtime/syntax/testdir/dumps/java_comments_05.dump [deleted file]
runtime/syntax/testdir/dumps/java_comments_07.dump [deleted file]
runtime/syntax/testdir/dumps/java_comments_html_00.dump [moved from runtime/syntax/testdir/dumps/java_comments_00.dump with 92% similarity]
runtime/syntax/testdir/dumps/java_comments_html_01.dump [moved from runtime/syntax/testdir/dumps/java_comments_01.dump with 67% similarity]
runtime/syntax/testdir/dumps/java_comments_html_02.dump [moved from runtime/syntax/testdir/dumps/java_comments_02.dump with 98% similarity]
runtime/syntax/testdir/dumps/java_comments_html_03.dump [moved from runtime/syntax/testdir/dumps/java_comments_03.dump with 91% similarity]
runtime/syntax/testdir/dumps/java_comments_html_04.dump [moved from runtime/syntax/testdir/dumps/java_comments_04.dump with 55% similarity]
runtime/syntax/testdir/dumps/java_comments_html_05.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_html_06.dump [moved from runtime/syntax/testdir/dumps/java_comments_06.dump with 52% similarity]
runtime/syntax/testdir/dumps/java_comments_html_07.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_00.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_01.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_02.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_03.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_04.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_05.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_06.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_07.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_comments_markdown_08.dump [new file with mode: 0644]
runtime/syntax/testdir/dumps/java_module_info_00.dump
runtime/syntax/testdir/dumps/java_numbers_01.dump
runtime/syntax/testdir/input/java_comments_html.java [moved from runtime/syntax/testdir/input/java_comments.java with 74% similarity]
runtime/syntax/testdir/input/java_comments_markdown.java [new file with mode: 0644]