yard 0.9.39 → 0.9.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -1
- data/README.md +18 -21
- data/docs/GettingStarted.md +41 -15
- data/docs/Tags.md +5 -5
- data/docs/WhatsNew.md +59 -7
- data/docs/templates/default/yard_tags/html/setup.rb +1 -1
- data/lib/yard/autoload.rb +17 -0
- data/lib/yard/cli/diff.rb +7 -2
- data/lib/yard/code_objects/proxy.rb +1 -1
- data/lib/yard/handlers/processor.rb +1 -0
- data/lib/yard/handlers/rbs/attribute_handler.rb +43 -0
- data/lib/yard/handlers/rbs/base.rb +38 -0
- data/lib/yard/handlers/rbs/constant_handler.rb +18 -0
- data/lib/yard/handlers/rbs/method_handler.rb +327 -0
- data/lib/yard/handlers/rbs/mixin_handler.rb +20 -0
- data/lib/yard/handlers/rbs/namespace_handler.rb +26 -0
- data/lib/yard/handlers/ruby/attribute_handler.rb +7 -4
- data/lib/yard/handlers/ruby/constant_handler.rb +1 -0
- data/lib/yard/i18n/locale.rb +1 -1
- data/lib/yard/i18n/pot_generator.rb +1 -1
- data/lib/yard/parser/rbs/rbs_parser.rb +325 -0
- data/lib/yard/parser/rbs/statement.rb +75 -0
- data/lib/yard/parser/ruby/ruby_parser.rb +51 -1
- data/lib/yard/parser/source_parser.rb +3 -2
- data/lib/yard/registry_resolver.rb +7 -0
- data/lib/yard/server/library_version.rb +1 -1
- data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +208 -12
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +1 -17
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -2
- data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +3 -3
- data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +2 -3
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +22 -16
- data/lib/yard/tags/directives.rb +7 -0
- data/lib/yard/tags/library.rb +3 -3
- data/lib/yard/tags/types_explainer.rb +2 -1
- data/lib/yard/templates/helpers/base_helper.rb +1 -1
- data/lib/yard/templates/helpers/html_helper.rb +15 -4
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +6 -1
- data/lib/yard/templates/helpers/markup/hybrid_markdown.rb +2125 -0
- data/lib/yard/templates/helpers/markup_helper.rb +4 -2
- data/lib/yard/version.rb +1 -1
- data/po/ja.po +82 -82
- data/templates/default/fulldoc/html/full_list.erb +4 -4
- data/templates/default/fulldoc/html/js/app.js +503 -319
- data/templates/default/fulldoc/html/js/full_list.js +310 -213
- data/templates/default/layout/html/headers.erb +1 -1
- data/templates/default/method/html/header.erb +3 -3
- data/templates/default/module/html/defines.erb +3 -3
- data/templates/default/module/html/inherited_methods.erb +1 -0
- data/templates/default/module/html/method_summary.erb +8 -0
- data/templates/default/module/setup.rb +20 -0
- data/templates/default/onefile/html/layout.erb +3 -4
- data/templates/guide/fulldoc/html/js/app.js +57 -26
- data/templates/guide/layout/html/layout.erb +9 -11
- metadata +13 -4
|
@@ -23,6 +23,7 @@ module YARD
|
|
|
23
23
|
# The default list of markup providers for each markup type
|
|
24
24
|
MARKUP_PROVIDERS = {
|
|
25
25
|
:markdown => [
|
|
26
|
+
{:lib => :yard, :const => 'YARD::Templates::Helpers::Markup::HybridMarkdown'},
|
|
26
27
|
{:lib => :redcarpet, :const => 'RedcarpetCompat'},
|
|
27
28
|
{:lib => :rdiscount, :const => 'RDiscount'},
|
|
28
29
|
{:lib => :kramdown, :const => 'Kramdown::Document'},
|
|
@@ -30,7 +31,7 @@ module YARD
|
|
|
30
31
|
{:lib => :maruku, :const => 'Maruku'},
|
|
31
32
|
{:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
|
|
32
33
|
{:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
|
|
33
|
-
{:lib => :commonmarker, :const => 'CommonMarker'}
|
|
34
|
+
{:lib => :commonmarker, :const => defined?(CommonMarker) ? 'CommonMarker' : 'Commonmarker' }
|
|
34
35
|
],
|
|
35
36
|
:textile => [
|
|
36
37
|
{:lib => :redcloth, :const => 'RedCloth'}
|
|
@@ -39,7 +40,8 @@ module YARD
|
|
|
39
40
|
{:lib => :redcloth, :const => 'RedCloth'}
|
|
40
41
|
],
|
|
41
42
|
:rdoc => [
|
|
42
|
-
{:lib =>
|
|
43
|
+
{:lib => :yard, :const => 'YARD::Templates::Helpers::Markup::HybridMarkdown'},
|
|
44
|
+
{:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'}
|
|
43
45
|
],
|
|
44
46
|
:org => [
|
|
45
47
|
{:lib => :'org-ruby', :const => 'Orgmode::Parser'}
|
data/lib/yard/version.rb
CHANGED
data/po/ja.po
CHANGED
|
@@ -27,10 +27,10 @@ msgstr ""
|
|
|
27
27
|
|
|
28
28
|
#: ../README.md:4
|
|
29
29
|
msgid ""
|
|
30
|
-
"**Homepage**: [
|
|
30
|
+
"**Homepage**: [https://yardoc.org](https://yardoc.org) \n"
|
|
31
31
|
"**IRC**: [irc.freenode.net / #yard](irc://irc.freenode.net/"
|
|
32
32
|
"yard) \n"
|
|
33
|
-
"**Git**: [
|
|
33
|
+
"**Git**: [https://github.com/lsegal/yard](https://github.com/lsegal/"
|
|
34
34
|
"yard) \n"
|
|
35
35
|
"**Author**: Loren Segal \n"
|
|
36
36
|
"**Contributors**: See Contributors section below \n"
|
|
@@ -39,9 +39,9 @@ msgid ""
|
|
|
39
39
|
"**Latest Version**: 0.8.2.1 (codename \"Shave It\") \n"
|
|
40
40
|
"**Release Date**: June 10th 2012"
|
|
41
41
|
msgstr ""
|
|
42
|
-
"**Homepage**: [
|
|
42
|
+
"**Homepage**: [https://yardoc.org](https://yardoc.org) \n"
|
|
43
43
|
"**IRC**: [irc.freenode.net / #yard](irc://irc.freenode.net/yard) \n"
|
|
44
|
-
"**Git**: [
|
|
44
|
+
"**Git**: [https://github.com/lsegal/yard](https://github.com/lsegal/yard) \n"
|
|
45
45
|
"**Author**: Loren Segal \n"
|
|
46
46
|
"**Contributors**: See Contributors section below \n"
|
|
47
47
|
"**Copyright**: 2007-2012 \n"
|
|
@@ -686,7 +686,7 @@ msgstr " $ yard server"
|
|
|
686
686
|
msgid ""
|
|
687
687
|
"And the project inside the current directory will be parsed (if the source "
|
|
688
688
|
"has\n"
|
|
689
|
-
"not yet been scanned by YARD) and served at [http://localhost:8808](
|
|
689
|
+
"not yet been scanned by YARD) and served at [http://localhost:8808](https://"
|
|
690
690
|
"localhost:8808)."
|
|
691
691
|
msgstr ""
|
|
692
692
|
"上のコマンドによってプロジェクトの現在のディレクトリ内部は解析される。\n"
|
|
@@ -748,7 +748,7 @@ msgstr "**5. `yard graph` はGraphvizのジェネレーター**"
|
|
|
748
748
|
msgid ""
|
|
749
749
|
"You can use `yard graph` to generate dot graphs of your code. This, of "
|
|
750
750
|
"course,\n"
|
|
751
|
-
"requires [Graphviz](
|
|
751
|
+
"requires [Graphviz](https://www.graphviz.org) and the `dot` binary. By "
|
|
752
752
|
"default\n"
|
|
753
753
|
"this will generate a graph of the classes and modules in the best UML2 "
|
|
754
754
|
"notation\n"
|
|
@@ -764,7 +764,7 @@ msgid ""
|
|
|
764
764
|
"example:"
|
|
765
765
|
msgstr ""
|
|
766
766
|
"あなたのコードの図を生成する為に `yard graph` を利用できる。\n"
|
|
767
|
-
"これにはもちろん、[Graphviz](
|
|
767
|
+
"これにはもちろん、[Graphviz](https://www.graphviz.org)と `dot` が必要となる。\n"
|
|
768
768
|
"デフォルトでこれは、Graphvizのサポートできる最高のURL2表記で\n"
|
|
769
769
|
"クラスやモジュールの図を生成する。しかし、記載されたメソッドは生成しない。\n"
|
|
770
770
|
"`-- full` オプションを用いメソッドと属性が記述される。\n"
|
|
@@ -1283,7 +1283,7 @@ msgstr ""
|
|
|
1283
1283
|
#: ../README.md:495
|
|
1284
1284
|
msgid ""
|
|
1285
1285
|
"- **November.15.09**: 0.4.0 release\n"
|
|
1286
|
-
" - Added new templating engine based on [tadpole](
|
|
1286
|
+
" - Added new templating engine based on [tadpole](https://github.com/"
|
|
1287
1287
|
"lsegal/tadpole)\n"
|
|
1288
1288
|
" - Added YARD queries (`--query` CLI argument to yardoc)\n"
|
|
1289
1289
|
" - Greatly expanded YARD documentation\n"
|
|
@@ -1293,7 +1293,7 @@ msgid ""
|
|
|
1293
1293
|
" - Read about changes in {file:docs/WhatsNew.md}"
|
|
1294
1294
|
msgstr ""
|
|
1295
1295
|
"- **November.15.09**: 0.4.0 release\n"
|
|
1296
|
-
" - Added new templating engine based on [tadpole](
|
|
1296
|
+
" - Added new templating engine based on [tadpole](https://github.com/lsegal/tadpole)\n"
|
|
1297
1297
|
" - Added YARD queries (`--query` CLI argument to yardoc)\n"
|
|
1298
1298
|
" - Greatly expanded YARD documentation\n"
|
|
1299
1299
|
" - Added plugin support\n"
|
|
@@ -1422,8 +1422,8 @@ msgstr ""
|
|
|
1422
1422
|
"これらのパッチを投げた全ての貢献者のリストは次で見れる:"
|
|
1423
1423
|
|
|
1424
1424
|
#: ../README.md:551
|
|
1425
|
-
msgid "
|
|
1426
|
-
msgstr "
|
|
1425
|
+
msgid "https://github.com/lsegal/yard/contributors"
|
|
1426
|
+
msgstr "https://github.com/lsegal/yard/contributors"
|
|
1427
1427
|
|
|
1428
1428
|
#: ../README.md:553
|
|
1429
1429
|
msgid "## Copyright"
|
|
@@ -2259,7 +2259,7 @@ msgid ""
|
|
|
2259
2259
|
"are defined \"by convention\". To view samples of common type "
|
|
2260
2260
|
"specifications\n"
|
|
2261
2261
|
"and recommended conventions for writing type specifications, see\n"
|
|
2262
|
-
"[
|
|
2262
|
+
"[https://yardoc.org/types.html](https://yardoc.org/types.html). Note that "
|
|
2263
2263
|
"these\n"
|
|
2264
2264
|
"conventions may change every now and then, although we are working on a "
|
|
2265
2265
|
"more\n"
|
|
@@ -2268,7 +2268,7 @@ msgstr ""
|
|
|
2268
2268
|
"我々が述べてきたこれらのフィールドの型は殆どがフリーフォームである。\n"
|
|
2269
2269
|
"実のところ,それらは慣習によって定義される。\n"
|
|
2270
2270
|
"型の指定用に一般的な型指定の例や推奨される慣習を調べるには、\n"
|
|
2271
|
-
"[
|
|
2271
|
+
"[https://yardoc.org/types.html](https://yardoc.org/types.html)を参照\n"
|
|
2272
2272
|
"これらの慣習はいつの日か変更されるかもしれない、\n"
|
|
2273
2273
|
"けれども我々はより正式な型指定の提案に取りかかっている。"
|
|
2274
2274
|
|
|
@@ -2285,7 +2285,7 @@ msgid ""
|
|
|
2285
2285
|
"methods that perform similar metaprogramming tasks, and it is often useful\n"
|
|
2286
2286
|
"to document their functionality in your application. Consider the "
|
|
2287
2287
|
"`property`\n"
|
|
2288
|
-
"method in a project like [DataMapper](
|
|
2288
|
+
"method in a project like [DataMapper](https://datamapper.org), which creates\n"
|
|
2289
2289
|
"a typed attribute for a database model. The code might look like:"
|
|
2290
2290
|
msgstr ""
|
|
2291
2291
|
"Rubyの中のアプリケーションコードは、\n"
|
|
@@ -2295,7 +2295,7 @@ msgstr ""
|
|
|
2295
2295
|
"とはいうものの、フレームワークやライブラリでは、\n"
|
|
2296
2296
|
"大抵似たようなメタプログラミング作業を実行するカスタムメソッドを目にする。\n"
|
|
2297
2297
|
"そして、それはアプリケーションの中にある機能を記述する為に便利である。\n"
|
|
2298
|
-
"[DataMapper](
|
|
2298
|
+
"[DataMapper](https://datamapper.org)のようにプロジェクトの中の `property` メソッドを考え、\n"
|
|
2299
2299
|
"そして、データベースモデル用の属性の型を作成すると\n"
|
|
2300
2300
|
"コードは次のようになる。"
|
|
2301
2301
|
|
|
@@ -2645,8 +2645,8 @@ msgid " # !{ :some_key => 'value' }"
|
|
|
2645
2645
|
msgstr " # !{ :some_key => 'value' }"
|
|
2646
2646
|
|
|
2647
2647
|
#: ../docs/GettingStarted.md:334
|
|
2648
|
-
msgid "### Linking URLs `{
|
|
2649
|
-
msgstr "### URLのリンク `{
|
|
2648
|
+
msgid "### Linking URLs `{https://...}`"
|
|
2649
|
+
msgstr "### URLのリンク `{https://...}`"
|
|
2650
2650
|
|
|
2651
2651
|
#: ../docs/GettingStarted.md:336
|
|
2652
2652
|
msgid "URLs are also linked using this `{...}` syntax:"
|
|
@@ -2654,10 +2654,10 @@ msgstr "URLはこの`{...}`構文を用いリンクされる。"
|
|
|
2654
2654
|
|
|
2655
2655
|
#: ../docs/GettingStarted.md:338
|
|
2656
2656
|
msgid ""
|
|
2657
|
-
" {
|
|
2657
|
+
" {https://example.com Optional Title}\n"
|
|
2658
2658
|
" {mailto:email@example.com}"
|
|
2659
2659
|
msgstr ""
|
|
2660
|
-
" {
|
|
2660
|
+
" {https://example.com Optional Title}\n"
|
|
2661
2661
|
" {mailto:email@example.com}"
|
|
2662
2662
|
|
|
2663
2663
|
#: ../docs/GettingStarted.md:341
|
|
@@ -3287,11 +3287,11 @@ msgstr ""
|
|
|
3287
3287
|
|
|
3288
3288
|
#: ../docs/GettingStarted.md:581
|
|
3289
3289
|
msgid ""
|
|
3290
|
-
" $ gem install yard-rspec -s
|
|
3290
|
+
" $ gem install yard-rspec -s https://gemcutter.org\n"
|
|
3291
3291
|
" or\n"
|
|
3292
3292
|
" $ git clone git://github.com/lsegal/yard-spec-plugin"
|
|
3293
3293
|
msgstr ""
|
|
3294
|
-
" $ gem install yard-rspec -s
|
|
3294
|
+
" $ gem install yard-rspec -s https://gemcutter.org\n"
|
|
3295
3295
|
" or\n"
|
|
3296
3296
|
" $ git clone git://github.com/lsegal/yard-spec-plugin"
|
|
3297
3297
|
|
|
@@ -3315,13 +3315,13 @@ msgstr ""
|
|
|
3315
3315
|
|
|
3316
3316
|
#: ../docs/GettingStarted.md:590
|
|
3317
3317
|
msgid ""
|
|
3318
|
-
"[graphviz]:
|
|
3319
|
-
"[yard-rspec]:
|
|
3320
|
-
"[rspec]:
|
|
3318
|
+
"[graphviz]:https://www.graphviz.org\n"
|
|
3319
|
+
"[yard-rspec]:https://github.com/lsegal/yard-spec-plugin\n"
|
|
3320
|
+
"[rspec]:https://rspec.info"
|
|
3321
3321
|
msgstr ""
|
|
3322
|
-
"[graphviz]:
|
|
3323
|
-
"[yard-rspec]:
|
|
3324
|
-
"[rspec]:
|
|
3322
|
+
"[graphviz]:https://www.graphviz.org\n"
|
|
3323
|
+
"[yard-rspec]:https://github.com/lsegal/yard-spec-plugin\n"
|
|
3324
|
+
"[rspec]:https://rspec.info"
|
|
3325
3325
|
|
|
3326
3326
|
# title
|
|
3327
3327
|
#: ../docs/Handlers.md:1
|
|
@@ -4877,13 +4877,13 @@ msgid ""
|
|
|
4877
4877
|
"<p class=\"note\">\n"
|
|
4878
4878
|
" A list of examples of common type listings and what they translate into "
|
|
4879
4879
|
"is\n"
|
|
4880
|
-
" available at <a href=\"
|
|
4880
|
+
" available at <a href=\"https://yardoc.org/types\">https://yardoc.org/types</"
|
|
4881
4881
|
"a>.\n"
|
|
4882
4882
|
"</p>"
|
|
4883
4883
|
msgstr ""
|
|
4884
4884
|
"<p class=\"note\">\n"
|
|
4885
4885
|
" A list of examples of common type listings and what they translate into is\n"
|
|
4886
|
-
" available at <a href=\"
|
|
4886
|
+
" available at <a href=\"https://yardoc.org/types\">https://yardoc.org/types</a>.\n"
|
|
4887
4887
|
"</p>"
|
|
4888
4888
|
|
|
4889
4889
|
#: ../docs/Tags.md:146
|
|
@@ -7316,12 +7316,12 @@ msgid ""
|
|
|
7316
7316
|
"YARD now ships with the beginnings of internationalization support\n"
|
|
7317
7317
|
"for translating documentation into multiple languages. The\n"
|
|
7318
7318
|
"`yard i18n` command now allows you to generate \".pot\" and ultimately\n"
|
|
7319
|
-
"\".po\" files for translation with [gettext](
|
|
7319
|
+
"\".po\" files for translation with [gettext](https://www.gnu.org/software/"
|
|
7320
7320
|
"gettext)."
|
|
7321
7321
|
msgstr ""
|
|
7322
7322
|
"YARDは複数の言語に翻訳したドキュメント用に国際化サポートを送りだすことになった。\n"
|
|
7323
7323
|
"`yard i18n` コマンドは\n"
|
|
7324
|
-
"あなたが[gettext](
|
|
7324
|
+
"あなたが[gettext](https://www.gnu.org/software/gettext)を用いた翻訳用の\n"
|
|
7325
7325
|
"\".pot\"と最後に\".po\"ファイルを生成するのを許可するようになった。"
|
|
7326
7326
|
|
|
7327
7327
|
#: ../docs/WhatsNew.md:169
|
|
@@ -7561,7 +7561,7 @@ msgid ""
|
|
|
7561
7561
|
"But note that `--query` does not work when YARD is in \"safe mode\"\n"
|
|
7562
7562
|
"due to security concerns, whereas `--api` works in either mode.\n"
|
|
7563
7563
|
"This enables `--api` to function on remote documentation sites like\n"
|
|
7564
|
-
"[rubydoc.info](
|
|
7564
|
+
"[rubydoc.info](https://rubydoc.info)."
|
|
7565
7565
|
msgstr ""
|
|
7566
7566
|
|
|
7567
7567
|
#: ../docs/WhatsNew.md:282
|
|
@@ -8308,7 +8308,7 @@ msgid ""
|
|
|
8308
8308
|
"repercussion.\n"
|
|
8309
8309
|
" You can also add this switch to your `~/.gemrc` file so that you don't "
|
|
8310
8310
|
"need\n"
|
|
8311
|
-
" to re-type it each time. See [this link](
|
|
8311
|
+
" to re-type it each time. See [this link](https://stackoverflow.com/"
|
|
8312
8312
|
"questions/1789376/how-do-i-make-no-ri-no-rdoc-the-default-for-gem-install)\n"
|
|
8313
8313
|
" for exact instructions.</span>"
|
|
8314
8314
|
msgstr ""
|
|
@@ -8317,7 +8317,7 @@ msgstr ""
|
|
|
8317
8317
|
" will do this for you on-the-fly. It is therefore possible to speed up your\n"
|
|
8318
8318
|
" gem installs by using `gem install GEMNAME --no-rdoc` without repercussion.\n"
|
|
8319
8319
|
" You can also add this switch to your `~/.gemrc` file so that you don't need\n"
|
|
8320
|
-
" to re-type it each time. See [this link](
|
|
8320
|
+
" to re-type it each time. See [this link](https://stackoverflow.com/questions/1789376/how-do-i-make-no-ri-no-rdoc-the-default-for-gem-install)\n"
|
|
8321
8321
|
" for exact instructions.</span>"
|
|
8322
8322
|
|
|
8323
8323
|
#: ../docs/WhatsNew.md:572
|
|
@@ -8509,8 +8509,8 @@ msgstr ""
|
|
|
8509
8509
|
#: ../docs/WhatsNew.md:642
|
|
8510
8510
|
msgid ""
|
|
8511
8511
|
"For an overview of how to use `yard diff`, see [YARD Object Oriented Diffing]"
|
|
8512
|
-
"(
|
|
8513
|
-
msgstr "For an overview of how to use `yard diff`, see [YARD Object Oriented Diffing](
|
|
8512
|
+
"(https://gnuu.org/2010/06/26/yard-object-oriented-diffing/)."
|
|
8513
|
+
msgstr "For an overview of how to use `yard diff`, see [YARD Object Oriented Diffing](https://gnuu.org/2010/06/26/yard-object-oriented-diffing/)."
|
|
8514
8514
|
|
|
8515
8515
|
#: ../docs/WhatsNew.md:644
|
|
8516
8516
|
msgid "## `yard stats` to display statistics and undocumented objects (0.6.0)"
|
|
@@ -8987,14 +8987,14 @@ msgstr ""
|
|
|
8987
8987
|
msgid ""
|
|
8988
8988
|
"It is now possible to document native Ruby extensions with YARD with a new\n"
|
|
8989
8989
|
"C parser mostly borrowed from RDoc. This enables the ability to document\n"
|
|
8990
|
-
"Ruby's core and stdlibs which will be hosted on
|
|
8990
|
+
"Ruby's core and stdlibs which will be hosted on https://yardoc.org/docs. In\n"
|
|
8991
8991
|
"addition, the .yardoc dump for the Ruby-core classes will become available\n"
|
|
8992
8992
|
"as an installable gem for yri support (see #3)."
|
|
8993
8993
|
msgstr ""
|
|
8994
8994
|
"大部分をRDocから取り入れた新しいCパーサーと共にYARDを用い\n"
|
|
8995
8995
|
"Rubyの拡張ドキュメントを実行可能になった。\n"
|
|
8996
8996
|
"これは、Rubyのコアと標準ライブラリを記述する事を可能にする。\n"
|
|
8997
|
-
"そして、
|
|
8997
|
+
"そして、https://yardoc.org/docs でホスト(アクセスできる)されるだろう。\n"
|
|
8998
8998
|
"さらに、Rubyコアクラス用の.yardocのダンプは、\n"
|
|
8999
8999
|
"yriのサポートに用いるインストール可能なgemとして利用可能になるだろう。(#3 参"
|
|
9000
9000
|
"照)"
|
|
@@ -9646,10 +9646,10 @@ msgstr ""
|
|
|
9646
9646
|
|
|
9647
9647
|
#: ../docs/WhatsNew.md:1068
|
|
9648
9648
|
msgid ""
|
|
9649
|
-
"[
|
|
9650
|
-
"ad38a68dd73898b06bd5d0a1912b7d815878fae0](
|
|
9649
|
+
"[https://github.com/lsegal/yard/commit/"
|
|
9650
|
+
"ad38a68dd73898b06bd5d0a1912b7d815878fae0](https://github.com/lsegal/yard/"
|
|
9651
9651
|
"commit/ad38a68dd73898b06bd5d0a1912b7d815878fae0)"
|
|
9652
|
-
msgstr "[
|
|
9652
|
+
msgstr "[https://github.com/lsegal/yard/commit/ad38a68dd73898b06bd5d0a1912b7d815878fae0](https://github.com/lsegal/yard/commit/ad38a68dd73898b06bd5d0a1912b7d815878fae0)"
|
|
9653
9653
|
|
|
9654
9654
|
#: ../docs/WhatsNew.md:1071
|
|
9655
9655
|
msgid ""
|
|
@@ -10670,7 +10670,7 @@ msgstr "コマンドラインユーティリティを起動する。"
|
|
|
10670
10670
|
msgid "each tokenized argument"
|
|
10671
10671
|
msgstr "個々にトークナイズされた引数"
|
|
10672
10672
|
|
|
10673
|
-
# @example
|
|
10673
|
+
# @example
|
|
10674
10674
|
#: ../lib/yard/cli/graph.rb:50
|
|
10675
10675
|
msgid ""
|
|
10676
10676
|
"grapher = Graph.new\n"
|
|
@@ -11706,7 +11706,7 @@ msgstr "追加の検索パスのリスト"
|
|
|
11706
11706
|
msgid "a new instance of YRI"
|
|
11707
11707
|
msgstr "YRIの新しいインスタンス"
|
|
11708
11708
|
|
|
11709
|
-
# @example
|
|
11709
|
+
# @example
|
|
11710
11710
|
#: ../lib/yard/cli/yri.rb:49
|
|
11711
11711
|
msgid "YRI.new.run('String#reverse')"
|
|
11712
11712
|
msgstr ""
|
|
@@ -14321,10 +14321,10 @@ msgstr "このクラスrootオブジェクトにはならない"
|
|
|
14321
14321
|
|
|
14322
14322
|
# @note
|
|
14323
14323
|
#: ../lib/yard/code_objects/proxy.rb:218
|
|
14324
|
-
msgid "this method fixes a bug in 1.9.2:
|
|
14324
|
+
msgid "this method fixes a bug in 1.9.2: https://gist.github.com/437136"
|
|
14325
14325
|
msgstr ""
|
|
14326
14326
|
"このメソッドはバグを修正する。\n"
|
|
14327
|
-
"(in 1.9.2:
|
|
14327
|
+
"(in 1.9.2: https://gist.github.com/4371369)"
|
|
14328
14328
|
|
|
14329
14329
|
# YARD::CodeObjects::Proxy#to_obj
|
|
14330
14330
|
#: ../lib/yard/code_objects/proxy.rb:221
|
|
@@ -14906,7 +14906,7 @@ msgid ""
|
|
|
14906
14906
|
"value in a list."
|
|
14907
14907
|
msgstr "Insertionクラスはリストの中の前後に他の値を挿入する。"
|
|
14908
14908
|
|
|
14909
|
-
# @example
|
|
14909
|
+
# @example
|
|
14910
14910
|
#: ../lib/yard/core_ext/insertion.rb:6
|
|
14911
14911
|
msgid "Insertion.new([1, 2, 3], 4).before(3) # => [1, 2, 4, 3]"
|
|
14912
14912
|
msgstr ""
|
|
@@ -15033,7 +15033,7 @@ msgstr "オブジェクトが置かれる所の相対インデックス(0又は1
|
|
|
15033
15033
|
msgid "Returns the class name of a full module namespace path"
|
|
15034
15034
|
msgstr "モジュールの完全なnamespaceパスのクラス名を返す"
|
|
15035
15035
|
|
|
15036
|
-
# @example
|
|
15036
|
+
# @example
|
|
15037
15037
|
#: ../lib/yard/core_ext/module.rb:7
|
|
15038
15038
|
msgid "module A::B::C; class_name end # => \"C\""
|
|
15039
15039
|
msgstr ""
|
|
@@ -15405,7 +15405,7 @@ msgstr ""
|
|
|
15405
15405
|
"任意のオブジェクトに追加された未加工のコンテンツを用い新しいdocstringを作成する。\n"
|
|
15406
15406
|
"解析は {DocstringParser} クラスによって完了する。"
|
|
15407
15407
|
|
|
15408
|
-
# @example
|
|
15408
|
+
# @example
|
|
15409
15409
|
#: ../lib/yard/docstring.rb:99
|
|
15410
15410
|
msgid "Docstring.new(\"hello world\\n@return Object return\", someobj)"
|
|
15411
15411
|
msgstr ""
|
|
@@ -15590,7 +15590,7 @@ msgstr ""
|
|
|
15590
15590
|
"タグオブジェクトのリストのような名前の中の、\n"
|
|
15591
15591
|
"最初のタグオブジェクトを返す為の便利なメソッド。"
|
|
15592
15592
|
|
|
15593
|
-
# @example
|
|
15593
|
+
# @example
|
|
15594
15594
|
#: ../lib/yard/docstring.rb:237
|
|
15595
15595
|
msgid ""
|
|
15596
15596
|
"doc = Docstring.new(\"@return zero when nil\")\n"
|
|
@@ -18006,7 +18006,7 @@ msgstr "accepted_types"
|
|
|
18006
18006
|
msgid "tag|param|token"
|
|
18007
18007
|
msgstr "token"
|
|
18008
18008
|
|
|
18009
|
-
# @example
|
|
18009
|
+
# @example
|
|
18010
18010
|
#: ../lib/yard/handlers/ruby/legacy/base.rb:116
|
|
18011
18011
|
msgid ""
|
|
18012
18012
|
"tokval(TokenList.new('\"foo\"').first) => \"foo\"\n"
|
|
@@ -18436,14 +18436,14 @@ msgid ""
|
|
|
18436
18436
|
"messages."
|
|
18437
18437
|
msgstr ""
|
|
18438
18438
|
|
|
18439
|
-
# @see
|
|
18439
|
+
# @see https://tools.ietf.org/rfc/bcp/bcp47.txt
|
|
18440
18440
|
#: ../lib/yard/i18n/locale.rb:15
|
|
18441
18441
|
msgid "BCP 47 - Tags for Identifying Languages"
|
|
18442
18442
|
msgstr ""
|
|
18443
18443
|
|
|
18444
18444
|
# @see
|
|
18445
18445
|
#: ../lib/yard/i18n/locale.rb:15
|
|
18446
|
-
msgid "tag|see|
|
|
18446
|
+
msgid "tag|see|https://tools.ietf.org/rfc/bcp/bcp47.txt"
|
|
18447
18447
|
msgstr ""
|
|
18448
18448
|
|
|
18449
18449
|
# @return [String]
|
|
@@ -18761,7 +18761,7 @@ msgid ""
|
|
|
18761
18761
|
"\"po/yard.pot\"."
|
|
18762
18762
|
msgstr ""
|
|
18763
18763
|
|
|
18764
|
-
# @see
|
|
18764
|
+
# @see https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
|
|
18765
18765
|
#: ../lib/yard/i18n/pot_generator.rb:64
|
|
18766
18766
|
msgid "GNU gettext manual about details of PO file"
|
|
18767
18767
|
msgstr ""
|
|
@@ -18793,7 +18793,7 @@ msgstr "tag|example|.popファイルを生成する"
|
|
|
18793
18793
|
# @see
|
|
18794
18794
|
#: ../lib/yard/i18n/pot_generator.rb:64
|
|
18795
18795
|
msgid ""
|
|
18796
|
-
"tag|see|
|
|
18796
|
+
"tag|see|https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html"
|
|
18797
18797
|
msgstr ""
|
|
18798
18798
|
|
|
18799
18799
|
# YARD::I18n::PotGenerator#messages
|
|
@@ -19214,7 +19214,7 @@ msgstr ""
|
|
|
19214
19214
|
msgid "Sets the logger level for the duration of the block"
|
|
19215
19215
|
msgstr "ブロックの継続するlogger levelを設定する。"
|
|
19216
19216
|
|
|
19217
|
-
# @example
|
|
19217
|
+
# @example
|
|
19218
19218
|
#: ../lib/yard/logging.rb:151
|
|
19219
19219
|
msgid ""
|
|
19220
19220
|
"log.enter_level(Logger::ERROR) do\n"
|
|
@@ -24256,7 +24256,7 @@ msgid ""
|
|
|
24256
24256
|
" # otherwise download it in a thread and return immediately\n"
|
|
24257
24257
|
" Thread.new do\n"
|
|
24258
24258
|
" # zip/unzip method implementations are not shown\n"
|
|
24259
|
-
" download_zip_file(\"
|
|
24259
|
+
" download_zip_file(\"https://mysite.com/yardocs/#{self}.zip\")\n"
|
|
24260
24260
|
" unzip_file_to(\"/path/to/yardocs/#{self}\")\n"
|
|
24261
24261
|
" self.yardoc_file = \"/path/to/yardocs/#{self}/.yardoc\"\n"
|
|
24262
24262
|
" self.source_path = self.yardoc_file\n"
|
|
@@ -24282,7 +24282,7 @@ msgstr ""
|
|
|
24282
24282
|
" # その他の場合、そのスレッドの中でダウンロードし直ぐに返す\n"
|
|
24283
24283
|
" Thread.new do\n"
|
|
24284
24284
|
" # zip/unzip メソッドの実装は示さない\n"
|
|
24285
|
-
" download_zip_file(\"
|
|
24285
|
+
" download_zip_file(\"https://mysite.com/yardocs/#{self}.zip\")\n"
|
|
24286
24286
|
" unzip_file_to(\"/path/to/yardocs/#{self}\")\n"
|
|
24287
24287
|
" self.yardoc_file = \"/path/to/yardocs/#{self}/.yardoc\"\n"
|
|
24288
24288
|
" self.source_path = self.yardoc_file\n"
|
|
@@ -25055,7 +25055,7 @@ msgstr ""
|
|
|
25055
25055
|
"テキスト行の先頭で[],<>,{},()ブロックのカンマで区切られた値の配列の中を解析す"
|
|
25056
25056
|
"る\n"
|
|
25057
25057
|
|
|
25058
|
-
# @example
|
|
25058
|
+
# @example
|
|
25059
25059
|
#: ../lib/yard/tags/default_factory.rb:125
|
|
25060
25060
|
msgid ""
|
|
25061
25061
|
"obj.parse_types('[String, Array<Hash, String>, nil]') # => [nil, ['String', "
|
|
@@ -25249,7 +25249,7 @@ msgid ""
|
|
|
25249
25249
|
"group listing."
|
|
25250
25250
|
msgstr ""
|
|
25251
25251
|
|
|
25252
|
-
# @example
|
|
25252
|
+
# @example
|
|
25253
25253
|
#: ../lib/yard/tags/directives.rb:97
|
|
25254
25254
|
msgid ""
|
|
25255
25255
|
"class Controller\n"
|
|
@@ -25279,7 +25279,7 @@ msgid ""
|
|
|
25279
25279
|
"use {tag:!endgroup}."
|
|
25280
25280
|
msgstr ""
|
|
25281
25281
|
|
|
25282
|
-
# @example
|
|
25282
|
+
# @example
|
|
25283
25283
|
#: ../lib/yard/tags/directives.rb:120
|
|
25284
25284
|
msgid ""
|
|
25285
25285
|
"# @!group Callbacks\n"
|
|
@@ -25999,7 +25999,7 @@ msgstr ""
|
|
|
25999
25999
|
"ばならない。\n"
|
|
26000
26000
|
"設定しない場合、あなたのfactoryクラスは利用できない。"
|
|
26001
26001
|
|
|
26002
|
-
# @example
|
|
26002
|
+
# @example
|
|
26003
26003
|
#: ../lib/yard/tags/library.rb:84
|
|
26004
26004
|
msgid "YARD::Tags::Library.default_factory = MyFactory"
|
|
26005
26005
|
msgstr ""
|
|
@@ -26306,7 +26306,7 @@ msgstr ""
|
|
|
26306
26306
|
msgid "[] API Visibility"
|
|
26307
26307
|
msgstr ""
|
|
26308
26308
|
|
|
26309
|
-
# @example
|
|
26309
|
+
# @example
|
|
26310
26310
|
#: ../lib/yard/tags/library.rb:327
|
|
26311
26311
|
msgid ""
|
|
26312
26312
|
"class Post\n"
|
|
@@ -26331,7 +26331,7 @@ msgstr ""
|
|
|
26331
26331
|
"任意のテキストは\n"
|
|
26332
26332
|
"このタグを受入可能であり、事前定義された値はない。"
|
|
26333
26333
|
|
|
26334
|
-
# @example
|
|
26334
|
+
# @example
|
|
26335
26335
|
#: ../lib/yard/tags/library.rb:337
|
|
26336
26336
|
msgid ""
|
|
26337
26337
|
"# @attr [String] name the name of the structure\n"
|
|
@@ -26368,7 +26368,7 @@ msgstr ""
|
|
|
26368
26368
|
msgid "Declares a readwrite attribute on a Struct or class."
|
|
26369
26369
|
msgstr ""
|
|
26370
26370
|
|
|
26371
|
-
# @example
|
|
26371
|
+
# @example
|
|
26372
26372
|
#: ../lib/yard/tags/library.rb:347 ../lib/yard/tags/library.rb:357
|
|
26373
26373
|
msgid ""
|
|
26374
26374
|
"# @attr_reader [String] name the name of the structure\n"
|
|
@@ -26424,7 +26424,7 @@ msgstr ""
|
|
|
26424
26424
|
msgid "Declares a writeonly attribute on a Struct or class."
|
|
26425
26425
|
msgstr ""
|
|
26426
26426
|
|
|
26427
|
-
# @example
|
|
26427
|
+
# @example
|
|
26428
26428
|
#: ../lib/yard/tags/library.rb:364
|
|
26429
26429
|
msgid ""
|
|
26430
26430
|
"# @author Foo Bar <foo@bar.com>\n"
|
|
@@ -26491,7 +26491,7 @@ msgid ""
|
|
|
26491
26491
|
"was marked as deprecated."
|
|
26492
26492
|
msgstr ""
|
|
26493
26493
|
|
|
26494
|
-
# @example
|
|
26494
|
+
# @example
|
|
26495
26495
|
#: ../lib/yard/tags/library.rb:391
|
|
26496
26496
|
msgid ""
|
|
26497
26497
|
"# @example Reverse a String\n"
|
|
@@ -26550,7 +26550,7 @@ msgstr ""
|
|
|
26550
26550
|
msgid "Adds an emphasized note at the top of the docstring for the object"
|
|
26551
26551
|
msgstr ""
|
|
26552
26552
|
|
|
26553
|
-
# @example
|
|
26553
|
+
# @example
|
|
26554
26554
|
#: ../lib/yard/tags/library.rb:418
|
|
26555
26555
|
msgid ""
|
|
26556
26556
|
"# @param [Hash] opts the options to create a message with.\n"
|
|
@@ -26599,7 +26599,7 @@ msgid ""
|
|
|
26599
26599
|
"hash itself, though it is useful to do so for completeness."
|
|
26600
26600
|
msgstr ""
|
|
26601
26601
|
|
|
26602
|
-
# @example
|
|
26602
|
+
# @example
|
|
26603
26603
|
#: ../lib/yard/tags/library.rb:437
|
|
26604
26604
|
msgid ""
|
|
26605
26605
|
"# @overload set(key, value)\n"
|
|
@@ -26644,7 +26644,7 @@ msgstr ""
|
|
|
26644
26644
|
"オーバーロードの様に自身の追加するメタデータタグを用い\n"
|
|
26645
26645
|
"新しいドキュメント文字列になる。"
|
|
26646
26646
|
|
|
26647
|
-
# @example
|
|
26647
|
+
# @example
|
|
26648
26648
|
#: ../lib/yard/tags/library.rb:445
|
|
26649
26649
|
msgid ""
|
|
26650
26650
|
"# @param [String] the URL of the page to download\n"
|
|
@@ -26669,7 +26669,7 @@ msgid ""
|
|
|
26669
26669
|
"and optional description."
|
|
26670
26670
|
msgstr ""
|
|
26671
26671
|
|
|
26672
|
-
# @example
|
|
26672
|
+
# @example
|
|
26673
26673
|
#: ../lib/yard/tags/library.rb:473
|
|
26674
26674
|
msgid ""
|
|
26675
26675
|
"# @private\n"
|
|
@@ -26723,7 +26723,7 @@ msgid ""
|
|
|
26723
26723
|
"switches."
|
|
26724
26724
|
msgstr ""
|
|
26725
26725
|
|
|
26726
|
-
# @example
|
|
26726
|
+
# @example
|
|
26727
26727
|
#: ../lib/yard/tags/library.rb:482
|
|
26728
26728
|
msgid ""
|
|
26729
26729
|
"# @raise [AccountBalanceError] if the account does not have\n"
|
|
@@ -26801,11 +26801,11 @@ msgid ""
|
|
|
26801
26801
|
"case should begin with \"if ...\"."
|
|
26802
26802
|
msgstr ""
|
|
26803
26803
|
|
|
26804
|
-
# @example
|
|
26804
|
+
# @example
|
|
26805
26805
|
#: ../lib/yard/tags/library.rb:510
|
|
26806
26806
|
msgid ""
|
|
26807
26807
|
"# Synchronizes system time using NTP.\n"
|
|
26808
|
-
"# @see
|
|
26808
|
+
"# @see https://ntp.org/documentation.html NTP Documentation\n"
|
|
26809
26809
|
"# @see NTPHelperMethods\n"
|
|
26810
26810
|
"class NTPUpdater; end"
|
|
26811
26811
|
msgstr ""
|
|
@@ -26833,7 +26833,7 @@ msgstr ""
|
|
|
26833
26833
|
"YARDによって自動的にリンクされ、\n"
|
|
26834
26834
|
"マークアップを用いフォーマットされる必要はない。"
|
|
26835
26835
|
|
|
26836
|
-
# @example
|
|
26836
|
+
# @example
|
|
26837
26837
|
#: ../lib/yard/tags/library.rb:518
|
|
26838
26838
|
msgid ""
|
|
26839
26839
|
"# @since 1.2.4\n"
|
|
@@ -26858,7 +26858,7 @@ msgstr "オブジェクトが最初に追加されたバージョンを記述す
|
|
|
26858
26858
|
msgid ""
|
|
26859
26859
|
"# @todo Add support for Jabberwocky service.\n"
|
|
26860
26860
|
"# There is an open source Jabberwocky library available\n"
|
|
26861
|
-
"# at
|
|
26861
|
+
"# at https://jbrwcky.org that can be easily integrated.\n"
|
|
26862
26862
|
"class Wonderlander; end"
|
|
26863
26863
|
msgstr ""
|
|
26864
26864
|
|
|
@@ -26911,10 +26911,10 @@ msgid ""
|
|
|
26911
26911
|
" end"
|
|
26912
26912
|
msgstr ""
|
|
26913
26913
|
|
|
26914
|
-
# @example
|
|
26914
|
+
# @example
|
|
26915
26915
|
#: ../lib/yard/tags/library.rb:557
|
|
26916
26916
|
msgid ""
|
|
26917
|
-
"# The public REST API for
|
|
26917
|
+
"# The public REST API for https://jbrwcky.org\n"
|
|
26918
26918
|
"# @version 2.0\n"
|
|
26919
26919
|
"class JabberwockyAPI; end"
|
|
26920
26920
|
msgstr ""
|
|
@@ -26940,7 +26940,7 @@ msgid ""
|
|
|
26940
26940
|
"of a specific object."
|
|
26941
26941
|
msgstr ""
|
|
26942
26942
|
|
|
26943
|
-
# @example
|
|
26943
|
+
# @example
|
|
26944
26944
|
#: ../lib/yard/tags/library.rb:573
|
|
26945
26945
|
msgid ""
|
|
26946
26946
|
"# For a block {|a,b,c| ... }\n"
|
|
@@ -26983,7 +26983,7 @@ msgid ""
|
|
|
26983
26983
|
"well."
|
|
26984
26984
|
msgstr ""
|
|
26985
26985
|
|
|
26986
|
-
# @example
|
|
26986
|
+
# @example
|
|
26987
26987
|
#: ../lib/yard/tags/library.rb:582
|
|
26988
26988
|
msgid ""
|
|
26989
26989
|
"# @yieldparam [String] name the name that is yielded\n"
|
|
@@ -27008,7 +27008,7 @@ msgid ""
|
|
|
27008
27008
|
"them via +@yield+ as well."
|
|
27009
27009
|
msgstr ""
|
|
27010
27010
|
|
|
27011
|
-
# @example
|
|
27011
|
+
# @example
|
|
27012
27012
|
#: ../lib/yard/tags/library.rb:591
|
|
27013
27013
|
msgid ""
|
|
27014
27014
|
"# @yieldreturn [Fixnum] the number to add 5 to.\n"
|
|
@@ -27769,7 +27769,7 @@ msgstr ""
|
|
|
27769
27769
|
|
|
27770
27770
|
# @example Linking a URL
|
|
27771
27771
|
#: ../lib/yard/templates/helpers/base_helper.rb:54
|
|
27772
|
-
msgid "linkify('
|
|
27772
|
+
msgid "linkify('https://example.com')"
|
|
27773
27773
|
msgstr ""
|
|
27774
27774
|
|
|
27775
27775
|
# @example Including docstring contents of an object
|
|
@@ -28020,7 +28020,7 @@ msgstr ""
|
|
|
28020
28020
|
msgid "the object to retrieve the type for"
|
|
28021
28021
|
msgstr "型を回収するオブジェクト"
|
|
28022
28022
|
|
|
28023
|
-
# @example
|
|
28023
|
+
# @example
|
|
28024
28024
|
#: ../lib/yard/templates/helpers/base_helper.rb:193
|
|
28025
28025
|
msgid ""
|
|
28026
28026
|
"s = format_object_title ModuleObject.new(:root, :MyModuleName)\n"
|