neovim/runtime
Christian Clason 2f2f434613 vim-patch:85f054a: 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: vim/vim#15740

85f054aa3f

Co-authored-by: Aliaksei Budavei <0x000c70@gmail.com>
Co-authored-by: Tim Pope <code@tpope.net>
2024-10-01 07:33:24 +02:00
..
autoload vim-patch:85f054a: runtime(java): Recognise the CommonMark form (///) of Javadoc comments 2024-10-01 07:33:24 +02:00
colors vim-patch:6908db4: runtime(colors): update colorschemes 2024-08-17 13:03:13 +02:00
compiler vim-patch:077d1d2: runtime(make): add compiler/make.vim to reset compiler plugin settings 2024-09-11 09:47:30 +02:00
doc vim-patch:85f054a: runtime(java): Recognise the CommonMark form (///) of Javadoc comments 2024-10-01 07:33:24 +02:00
ftplugin vim-patch:85f054a: runtime(java): Recognise the CommonMark form (///) of Javadoc comments 2024-10-01 07:33:24 +02:00
indent vim-patch:150b507: runtime(hcl,terraform): Add runtime files for HCL and Terraform (#30266) 2024-09-04 19:32:52 -05:00
keymap vim-patch:79a14c0: runtime(keymap): include Georgian keymap 2024-06-14 23:58:27 +02:00
lua vim-patch:9.1.0749: filetype: http files not recognized 2024-10-01 07:33:08 +02:00
macros vim-patch:79230f027a25 2024-02-16 08:57:45 +01:00
pack/dist/opt vim-patch:5753d99: runtime(nohlsearch): add missing loaded_hlsearch guard 2024-07-31 23:06:28 +02:00
plugin vim-patch:9.1.0694: matchparen is slow on a long line (#30134) 2024-08-25 06:07:43 +08:00
queries feat(defaults): pretty :help headings #30544 2024-09-27 08:53:30 -07:00
spell feat(runtime): import cleanadd.vim from Vim (#17699) 2022-03-13 04:52:45 +00:00
syntax vim-patch:85f054a: runtime(java): Recognise the CommonMark form (///) of Javadoc comments 2024-10-01 07:33:24 +02:00
tools vim-patch:e80086446cc2 (#19848) 2022-08-20 10:04:55 +02:00
tutor fix(tutor): incorrect lines marked as correct #29833 2024-08-16 10:35:13 -07:00
CMakeLists.txt build: various fixes 2024-02-01 12:06:55 +01:00
delmenu.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
filetype.lua refactor: use vim._with where possible 2024-06-28 19:58:31 +02:00
ftoff.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
ftplugin.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
ftplugof.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
indent.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
indoff.vim vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
macmap.vim re-integrate runtime/ vim-patch:0 #938 2014-07-29 02:12:31 +00:00
makemenu.vim vim-patch:9.1.0013: Modula2 filetype support lacking (#27020) 2024-01-16 17:45:57 +00:00
menu.vim vim-patch:e059fae10044 2023-08-24 11:33:06 +09:00
mswin.vim vim-patch:45da32964d6e 2024-03-14 15:04:31 +08:00
neovim.ico feat(windows): show icon in terminal titlebar, taskbar #20607 2022-10-13 05:48:12 -07:00
nvim.appdata.xml NVIM v0.10.0 2024-05-16 14:34:32 +02:00
nvim.desktop docs: misc (#29719) 2024-08-29 06:11:32 +08:00
nvim.png Dist: make icon a proper square (#9716) 2019-03-11 21:00:12 +01:00
optwin.vim vim-patch:9.1.0572: cannot specify tab page closing behaviour (#29682) 2024-07-13 08:56:58 +08:00
synmenu.vim vim-patch:9.1.0013: Modula2 filetype support lacking (#27020) 2024-01-16 17:45:57 +00:00
windows_icon.rc feat(win32): embed executable icon 2024-07-02 13:05:16 +02:00