vim/doc at 563e8ec8c78b4141a6497f14e825be2d63cb891c - vim

GitHub/vim

mirror of https://github.com/vim/vim synced 2025-07-16 09:12:00 +00:00

Files

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

arabic.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

autocmd.txt

runtime(doc): improve typedchar documentation for KeyInputPre autocmd

2024-08-18 16:57:04 +02:00

builtin.txt

patch 9.1.0741: No way to get prompt for input()/confirm()

2024-09-23 20:34:47 +02:00

change.txt

runtime(doc): tweak documentation style a bit

2024-07-28 17:03:29 +02:00

channel.txt

runtime(doc): minor updates.

2024-07-17 20:04:22 +02:00

cmdline.txt

runtime(doc): fix grammar in :h :keeppatterns

2024-08-20 20:20:43 +02:00

debug.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

debugger.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

develop.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

diff.txt

patch 9.1.0099: Not able to use diff() with 'diffexpr'

2024-02-12 20:24:56 +01:00

digraph.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

doctags.c

patch 9.0.0110: help tag generation picks up words in code examples

2022-07-30 12:03:16 +01:00

doctags.vim

patch 8.2.0140: CI does not test building doc tags

2020-01-21 22:13:42 +01:00

editing.txt

runtime(doc): fix inconsistencies in :h file-searching

2024-07-10 20:07:10 +02:00

eval.txt

runtime(doc): tweak documentation style a bit

2024-07-28 17:03:29 +02:00

evim-fr.1

…

evim-fr.UTF-8.1

…

evim-it.1

translation(it): update Italian manpages

2024-08-17 15:14:43 +02:00

evim-it.UTF-8.1

translation(it): update Italian manpages

2024-08-17 15:14:43 +02:00

evim-ja.UTF-8.1

…

evim-pl.1

…

evim-pl.UTF-8.1

…

evim-ru.1

translation(ru): update man pages

2024-08-20 19:57:00 +02:00

evim-ru.UTF-8.1

translation(ru): update man pages

2024-08-20 19:57:00 +02:00

evim-tr.1

patch 8.2.0859: no Turkish translation of the manual

2020-05-31 14:25:22 +02:00

evim-tr.UTF-8.1

patch 8.2.0859: no Turkish translation of the manual

2020-05-31 14:25:22 +02:00

evim.1

patch 9.1.0676: style issues with man pages

2024-08-15 21:39:33 +02:00

evim.man

patch 9.1.0676: style issues with man pages

2024-08-15 21:39:33 +02:00

farsi.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

filetype.txt

runtime(java): Recognise the CommonMark form (///) of Javadoc comments

2024-09-30 19:40:04 +02:00

fold.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

ft_ada.txt

runtime(doc): reformat gnat example

2024-09-29 10:10:51 +02:00

ft_context.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

ft_hare.txt

patch 9.1.0442: hare runtime files outdated

2024-05-24 08:05:00 +02:00

ft_mp.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

ft_ps1.txt

Update runtime files

2021-06-27 15:18:56 +02:00

ft_raku.txt

Update runtime files.

2022-02-26 12:25:45 +00:00

ft_rust.txt

runtime(doc): add missing help tags

2024-01-01 20:50:51 +01:00

ft_sql.txt

runtime(doc): fix inconsistent indent (#14089 )

2024-02-25 08:42:52 +01:00

gui_w32.txt

patch 9.1.0050: Win32 Keyboard handling is sub-optimal

2024-01-23 23:19:02 +01:00

gui_x11.txt

runtime(doc): update documentation

2024-04-22 20:55:32 +02:00

gui.txt

runtime(doc): minor updates.

2024-07-17 20:04:22 +02:00

hangulin.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

hebrew.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

help.txt

runtime(doc): Add ft_hare.txt to Reference Manual TOC

2024-05-27 17:14:17 +02:00

help.txt.info

…

helphelp.txt

runtime(doc): Update documentation

2024-04-10 16:57:46 +02:00

howto.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_cscop.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

if_lua.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_mzsch.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_ole.txt

runtime(doc): fix inconsistent indent (#14089 )

2024-02-25 08:42:52 +01:00

if_perl.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_pyth.txt

patch 9.1.0417: if_py: find_module has been removed in Python 3.12.0a7

2024-05-17 18:30:26 +02:00

if_ruby.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_sniff.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_tcl.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

indent.txt

runtime(doc): Fix typos in help documents

2024-05-05 18:42:31 +02:00

index.txt

patch 9.1.0581: Various lines are indented inconsistently

2024-07-14 10:20:20 +02:00

insert.txt

runtime(doc): fix typo

2024-08-25 15:49:54 +02:00

intro.txt

runtime(doc): typo in intro.txt

2024-04-11 22:11:21 +02:00

Make_all.mak

patch 9.1.0442: hare runtime files outdated

2024-05-24 08:05:00 +02:00

Make_mvc.mak

runtime(doc): update vim90 to vim91 in docs

2024-09-26 15:52:22 +02:00

Makefile

runtime(doc): update Makefile and make it portable between GNU and BSD

2024-08-16 21:13:50 +02:00

makehtml.awk

Update runtime files

2020-05-26 21:20:45 +02:00

maketags.awk

CI: Check help tags for errors (duplicates, missing, etc) (#13865 )

2024-01-14 19:24:05 +01:00

map.txt

runtime(doc): Fix typo in :help :command-modifiers

2024-09-26 16:05:02 +02:00

mbyte.txt

runtime(doc): fix typo "a xterm" -> "an xterm"

2024-07-17 20:41:48 +02:00

message.txt

patch 9.1.0178: E1513 might be confusing

2024-03-13 20:59:27 +01:00

mlang.txt

patch 9.1.0559: translation of vim scripts can be improved

2024-07-11 21:14:15 +02:00

motion.txt

patch 9.1.0699: "dvgo" is not always an inclusive motion

2024-08-28 20:39:24 +02:00

netbeans.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

options.txt

runtime(docs): update :set? command behavior table

2024-09-26 15:54:43 +02:00

os_390.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_amiga.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_beos.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_dos.txt

runtime(doc): fix typo in :h dos-colors

2024-09-24 16:36:37 +02:00

os_haiku.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_mac.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_mint.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_msdos.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_os2.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_qnx.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_risc.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_unix.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_vms.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

os_win32.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

pattern.txt

runtime(nohlsearch): include the the simple nohlsearch package

2024-06-18 19:32:39 +02:00

pi_getscript.txt

runtime(glvs): Correct the tag name of glvs-autoinstal

2024-09-29 09:50:52 +02:00

pi_gzip.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

pi_logipat.txt

Update runtime files.

2020-01-14 19:29:13 +01:00

pi_netrw.txt

patch 9.1.0747: various typos in repo found

2024-09-29 10:37:47 +02:00

pi_paren.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

pi_spec.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

pi_tar.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

pi_vimball.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

pi_zip.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

popup.txt

patch 9.1.0500: cannot switch buffer in a popup

2024-06-18 21:01:23 +02:00

print.txt

runtime(doc): update and remove some invalid links

2024-05-11 11:16:21 +02:00

quickfix.txt

patch 9.1.0747: various typos in repo found

2024-09-29 10:37:47 +02:00

quickref.txt

patch 9.1.0572: cannot specify tab page closing behaviour

2024-07-12 19:36:53 +02:00

quotes.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

recover.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

remote.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

repeat.txt

runtime(doc): fix a few style issues

2024-08-12 18:27:41 +02:00

rileft.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

russian.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

scroll.txt

runtime(doc): Remove wrong help tag CTRL-SHIFT-CR

2024-07-06 11:29:38 +02:00

sign.txt

patch 9.1.0540: Unused assignment in sign_define_cmd()

2024-07-07 20:33:46 +02:00

spell.txt

patch 9.1.0418: Cannot move to previous/next rare word

2024-05-17 18:52:45 +02:00

sponsor.txt

runtime(doc): Remove mentioning of the voting feature

2024-08-14 14:39:32 +02:00

starting.txt

runtime(doc): reword and reformat how to use defaults.vim

2024-09-15 19:43:06 +02:00

syntax.txt

runtime(java): Recognise the CommonMark form (///) of Javadoc comments

2024-09-30 19:40:04 +02:00

tabpage.txt

patch 9.1.0572: cannot specify tab page closing behaviour

2024-07-12 19:36:53 +02:00