1
0
forked from aniani/vim
Files
vim/runtime/ftplugin
Aliaksei Budavei 85f054aa3f 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>
2024-09-30 19:40:04 +02:00
..
2021-09-21 20:09:51 +02:00
2017-03-05 17:04:09 +01:00
2021-01-25 21:14:57 +01:00
2017-03-05 17:04:09 +01:00
2022-10-28 20:47:54 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2010-01-06 20:54:52 +01:00
2017-03-05 17:04:09 +01:00
2018-12-27 23:59:26 +01:00
2004-06-13 20:20:40 +00:00
2022-09-27 17:30:34 +01:00
2017-03-05 17:04:09 +01:00
2022-06-03 21:59:47 +01:00
2023-06-10 21:40:39 +01:00
2017-03-05 17:04:09 +01:00
2022-09-18 13:04:22 +01:00
2022-03-08 21:35:07 +00:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2012-04-25 19:07:41 +02:00
2014-08-29 15:12:19 +02:00
2021-09-09 21:55:11 +02:00
2017-03-05 17:04:09 +01:00
2022-04-27 15:25:03 +01:00
2017-03-05 17:04:09 +01:00
2022-07-01 18:45:04 +01:00
2006-04-30 18:54:39 +00:00
2021-01-25 21:14:57 +01:00
2007-05-05 18:24:42 +00:00
2022-09-18 13:04:22 +01:00
2023-12-28 23:17:54 +01:00
2022-09-10 13:13:14 +01:00
2010-01-06 20:54:52 +01:00
2022-09-10 13:13:14 +01:00
2022-01-08 21:51:59 +00:00
2010-01-06 20:54:52 +01:00
2021-09-21 20:09:51 +02:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-09-27 17:30:34 +01:00
2019-01-01 15:32:17 +01:00
2016-01-10 15:59:26 +01:00
2015-11-01 16:49:04 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2007-05-05 18:24:42 +00:00
2021-12-16 14:41:10 +00:00
2020-08-30 17:20:20 +02:00
2019-12-03 22:49:09 +01:00
2022-09-10 13:13:14 +01:00
2021-08-14 21:25:52 +02:00
2015-01-07 16:57:10 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2023-04-22 22:40:14 +01:00
2023-02-02 13:59:48 +00:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2018-08-11 18:00:22 +02:00
2023-05-14 18:50:25 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-04-27 15:25:03 +01:00
2021-09-09 21:55:11 +02:00
2017-03-05 17:04:09 +01:00
2007-05-05 17:56:55 +00:00
2017-03-05 17:04:09 +01:00
2017-11-02 22:58:42 +01:00
2023-04-22 22:40:14 +01:00
2021-10-23 12:08:41 +01:00
2024-09-01 09:21:16 +02:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-10-16 13:11:12 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-01-29 22:20:48 +00:00
2019-07-19 22:05:51 +02:00
2017-03-05 17:04:09 +01:00
2023-02-27 15:49:53 +00:00
2017-03-05 17:04:09 +01:00
2004-06-13 20:20:40 +00:00
2022-04-27 15:25:03 +01:00
2017-03-05 17:04:09 +01:00
2020-10-26 21:12:46 +01:00
2023-08-23 21:20:00 +02:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-10-16 13:11:12 +01:00
2022-07-29 21:36:21 +01:00
2021-01-11 19:40:15 +01:00
2017-03-05 17:04:09 +01:00
2021-09-09 21:55:11 +02:00
2022-06-14 17:41:28 +01:00
2017-03-05 17:04:09 +01:00
2021-09-09 21:55:11 +02:00
2019-01-17 16:07:22 +01:00
2024-07-07 21:07:56 +02:00
2021-10-16 15:23:36 +01:00
2017-03-05 17:04:09 +01:00
2022-06-14 17:41:28 +01:00
2020-08-15 18:55:18 +02:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2023-08-09 16:50:52 +02:00
2017-03-05 17:04:09 +01:00
2023-06-10 21:40:39 +01:00
2022-09-18 13:04:22 +01:00
2014-08-22 19:21:47 +02:00
2022-07-01 18:45:04 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2017-03-05 17:04:09 +01:00
2022-06-14 17:41:28 +01:00

The ftplugin directory is for Vim plugin scripts that are only used for a
specific filetype.

All files ending in .vim in this directory and subdirectories will be sourced
by Vim when it detects the filetype that matches the name of the file or
subdirectory.
For example, these are all loaded for the "c" filetype:

	c.vim
	c_extra.vim
	c/settings.vim

Note that the "_" in "c_extra.vim" is required to separate the filetype name
from the following arbitrary name.

The filetype plugins are only loaded when the ":filetype plugin" command has
been used.

The default filetype plugin files contain settings that 95% of the users will
want to use.  They do not contain personal preferences, like the value of
'shiftwidth'.

If you want to do additional settings, or overrule the default filetype
plugin, you can create your own plugin file.  See ":help ftplugin" in Vim.