Skip to content

Commit

Permalink
Merge pull request #1735 from vim-jp/hh-update-filetype
Browse files Browse the repository at this point in the history
Update filetype.{txt,jax}
  • Loading branch information
h-east authored Oct 13, 2024
2 parents a489631 + 0db0721 commit e5e5fa1
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 3 deletions.
22 changes: 21 additions & 1 deletion doc/filetype.jax
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*filetype.txt* For Vim バージョン 9.1. Last change: 2024 Aug 21
*filetype.txt* For Vim バージョン 9.1. Last change: 2024 Oct 05


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -689,6 +689,26 @@ Note Zip プラグインで読み込まれたバッファ内で "gf" コマン
から |FileType| イベントを手動でトリガーすること: >
doautocmd FileType
<
Markdown ドキュメントのコメントには、見た目上の理由から、コメントマーク (`///`)
の後に垂直の先頭の空白が続くことがある。ただし、Markdown では、コードブロック
などを示すため、先頭の空白の水平の連続が重要になる。便利のよいように、|gq|
ペレータに 'formatexpr' 機能が提供されている。"g:java_ignore_javadoc" も
"g:java_ignore_markdown" も定義されていない限り、Markdown コメントの再フォー
マットは、以下のようにしてオンデマンドで有効にできる: >
setlocal formatexpr=g:javaformat#RemoveCommonMarkdownWhitespace()
<
または、Vim バージョンが `7.4.265` 未満の場合は、以下のようにする: >
setlocal formatexpr=javaformat#RemoveCommonMarkdownWhitespace()
<
この関数は、行の範囲を受け入れ、共通の垂直方向の先頭の空白を削除し、範囲内の行
を書き換える。作成者のレイアウトスタイルとコメントの内容に応じて、再フォーマッ
トのために選択する行は、コメント全体からコメントの一部までさまざまである。

"g:java_ignore_markdown" または "g:java_ignore_javadoc" を削除した後で毎回
Markdown コメントの認識を有効にするには、`8.2.1397` 以降のバージョンの Vim で
は "javaformat.vim" を手動で再読込みすることを忘れないこと: >
runtime autoload/javaformat.vim
<

JSON-FORMAT *ft-json-plugin*

Expand Down
26 changes: 24 additions & 2 deletions en/filetype.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*filetype.txt* For Vim version 9.1. Last change: 2024 Aug 21
*filetype.txt* For Vim version 9.1. Last change: 2024 Oct 05


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -698,6 +698,28 @@ Remember to manually trigger the |FileType| event from a buffer with a Java
file loaded in it each time after assigning a new value to the variable: >
doautocmd FileType
<
Markdown documentation comments may contain common runs of vertical leading
whitespace following the comment marks (`///`) for aesthetic reasons; however,
some horizontal runs of leading whitespace are significant in Markdown because
they denote code blocks etc. For convenience, a 'formatexpr' function is
provided for the |gq| operator. As long as neither "g:java_ignore_javadoc"
nor "g:java_ignore_markdown" is defined, the reformatting of Markdown comments
can be enabled on demand with: >
setlocal formatexpr=g:javaformat#RemoveCommonMarkdownWhitespace()
<
Or for Vim versions less than `7.4.265`, with: >
setlocal formatexpr=javaformat#RemoveCommonMarkdownWhitespace()
<
This function accepts a range of lines, removes a common run of vertical
leading whitespace, and rewrites the lines of the range. Depending on the
author's layout style and the comment contents, which lines to select for
reformatting can vary from the whole comment to only some portion of it.

To enable the recognition of Markdown comments each time after removing
"g:java_ignore_markdown" or "g:java_ignore_javadoc", remember to manually
re-source "javaformat.vim" for Vim versions greater than `8.2.1397`: >
runtime autoload/javaformat.vim
<

JSON-FORMAT *ft-json-plugin*

Expand Down Expand Up @@ -754,7 +776,7 @@ Global mapping:
Local mappings:
<Plug>ManBS
<LocalLeader>h Clear backspace <BS> characters from the buffer
<LocalLeader>h Clear backspace <BS> characters from the buffer.
CTRL-] Jump to the manual page for the word under the cursor.
CTRL-T Jump back to the previous manual page.

Expand Down

0 comments on commit e5e5fa1

Please sign in to comment.