repeatable 1.2.0 → 1.2.1
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/.github/workflows/ci.yml +19 -23
- data/.ruby-version +1 -0
- data/.yardopts +1 -0
- data/CHANGELOG.md +16 -2
- data/Gemfile +1 -0
- data/Gemfile.lock +86 -73
- data/README.md +8 -5
- data/lib/repeatable/expression/date.rb +1 -0
- data/lib/repeatable/expression/range_in_year.rb +2 -0
- data/lib/repeatable/version.rb +1 -1
- data/rbi/repeatable.rbi +1 -1
- data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi} +3 -3
- data/sorbet/rbi/gems/benchmark@0.4.1.rbi +619 -0
- data/sorbet/rbi/gems/{commander@4.6.0.rbi → commander@5.0.0.rbi} +1 -0
- data/sorbet/rbi/gems/{diff-lcs@1.4.4.rbi → diff-lcs@1.6.2.rbi} +135 -83
- data/sorbet/rbi/gems/{erubi@1.12.0.rbi → erubi@1.13.1.rbi} +25 -15
- data/sorbet/rbi/gems/{highline@2.0.3.rbi → highline@3.0.1.rbi} +1 -0
- data/sorbet/rbi/gems/{json@2.7.2.rbi → json@2.13.2.rbi} +759 -233
- data/sorbet/rbi/gems/{language_server-protocol@3.17.0.3.rbi → language_server-protocol@3.17.0.5.rbi} +11 -5
- data/sorbet/rbi/gems/logger@1.7.0.rbi +963 -0
- data/sorbet/rbi/gems/{method_source@1.0.0.rbi → method_source@1.1.0.rbi} +41 -9
- data/sorbet/rbi/gems/{parallel@1.24.0.rbi → parallel@1.27.0.rbi} +32 -21
- data/sorbet/rbi/gems/{parlour@8.1.0.rbi → parlour@9.1.2.rbi} +86 -68
- data/sorbet/rbi/gems/{parser@3.3.1.0.rbi → parser@3.3.9.0.rbi} +908 -891
- data/sorbet/rbi/gems/{prism@0.28.0.rbi → prism@1.4.0.rbi} +14078 -10249
- data/sorbet/rbi/gems/{pry@0.14.0.rbi → pry@0.15.2.rbi} +437 -244
- data/sorbet/rbi/gems/{racc@1.7.3.rbi → racc@1.8.1.rbi} +36 -33
- data/sorbet/rbi/gems/{rake@13.0.3.rbi → rake@13.3.0.rbi} +83 -76
- data/sorbet/rbi/gems/rbi@0.3.6.rbi +6893 -0
- data/sorbet/rbi/gems/rbs@3.9.5.rbi +6976 -0
- data/sorbet/rbi/gems/{regexp_parser@2.9.0.rbi → regexp_parser@2.11.2.rbi} +1089 -1015
- data/sorbet/rbi/gems/{rexml@3.2.6.rbi → rexml@3.4.3.rbi} +833 -329
- data/sorbet/rbi/gems/{rspec-core@3.10.1.rbi → rspec-core@3.13.5.rbi} +1014 -613
- data/sorbet/rbi/gems/{rspec-expectations@3.10.1.rbi → rspec-expectations@3.13.5.rbi} +897 -638
- data/sorbet/rbi/gems/{rspec-mocks@3.10.2.rbi → rspec-mocks@3.13.5.rbi} +547 -444
- data/sorbet/rbi/gems/{rspec-support@3.10.2.rbi → rspec-support@3.13.5.rbi} +337 -304
- data/sorbet/rbi/gems/rspec@3.13.1.rbi +83 -0
- data/sorbet/rbi/gems/{rubocop-ast@1.31.3.rbi → rubocop-ast@1.46.0.rbi} +1678 -958
- data/sorbet/rbi/gems/{rubocop-performance@1.20.2.rbi → rubocop-performance@1.25.0.rbi} +1 -0
- data/sorbet/rbi/gems/{rubocop@1.62.1.rbi → rubocop@1.80.2.rbi} +11243 -5431
- data/sorbet/rbi/gems/simplecov-html@0.13.2.rbi +225 -0
- data/sorbet/rbi/gems/{simplecov@0.21.2.rbi → simplecov@0.22.0.rbi} +39 -25
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.4.rbi +233 -2
- data/sorbet/rbi/gems/spoom@1.6.3.rbi +6985 -0
- data/sorbet/rbi/gems/{standard-performance@1.3.1.rbi → standard-performance@1.8.0.rbi} +1 -0
- data/sorbet/rbi/gems/{standard@1.35.1.rbi → standard@1.51.0.rbi} +181 -96
- data/sorbet/rbi/gems/{tapioca@0.13.3.rbi → tapioca@0.16.11.rbi} +489 -388
- data/sorbet/rbi/gems/{thor@1.3.1.rbi → thor@1.4.0.rbi} +94 -46
- data/sorbet/rbi/gems/unicode-display_width@3.2.0.rbi +132 -0
- data/sorbet/rbi/gems/unicode-emoji@4.1.0.rbi +251 -0
- data/sorbet/rbi/gems/{yard-sorbet@0.8.1.rbi → yard-sorbet@0.9.0.rbi} +36 -29
- data/sorbet/rbi/gems/{yard@0.9.36.rbi → yard@0.9.37.rbi} +394 -236
- metadata +46 -40
- data/sorbet/rbi/gems/rbi@0.1.13.rbi +0 -3071
- data/sorbet/rbi/gems/rspec@3.10.0.rbi +0 -76
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -216
- data/sorbet/rbi/gems/spoom@1.3.2.rbi +0 -4420
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -65
- /data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +0 -0
@@ -3264,11 +3264,11 @@ YARD::CodeObjects::METHODNAMEMATCH = T.let(T.unsafe(nil), Regexp)
|
|
3264
3264
|
# # Extra data added to docstring
|
3265
3265
|
# property :bar
|
3266
3266
|
#
|
3267
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3267
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#29
|
3268
3268
|
class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
3269
3269
|
# @return [Boolean] whether this macro is attached to a method
|
3270
3270
|
#
|
3271
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3271
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#148
|
3272
3272
|
def attached?; end
|
3273
3273
|
|
3274
3274
|
# Expands the macro using
|
@@ -3283,39 +3283,39 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3283
3283
|
# call, if there is a block.
|
3284
3284
|
# @see expand
|
3285
3285
|
#
|
3286
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3286
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#166
|
3287
3287
|
def expand(call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3288
3288
|
|
3289
3289
|
# @return [String] the macro data stored on the object
|
3290
3290
|
#
|
3291
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3291
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3292
3292
|
def macro_data; end
|
3293
3293
|
|
3294
3294
|
# @return [String] the macro data stored on the object
|
3295
3295
|
#
|
3296
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3296
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3297
3297
|
def macro_data=(_arg0); end
|
3298
3298
|
|
3299
3299
|
# @return [CodeObjects::Base] the method object that this macro is
|
3300
3300
|
# attached to.
|
3301
3301
|
#
|
3302
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3302
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3303
3303
|
def method_object; end
|
3304
3304
|
|
3305
3305
|
# @return [CodeObjects::Base] the method object that this macro is
|
3306
3306
|
# attached to.
|
3307
3307
|
#
|
3308
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3308
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3309
3309
|
def method_object=(_arg0); end
|
3310
3310
|
|
3311
3311
|
# Overrides {Base#path} so the macro path is ".macro.MACRONAME"
|
3312
3312
|
#
|
3313
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3313
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#151
|
3314
3314
|
def path; end
|
3315
3315
|
|
3316
3316
|
# Overrides the separator to be '.'
|
3317
3317
|
#
|
3318
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3318
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#154
|
3319
3319
|
def sep; end
|
3320
3320
|
|
3321
3321
|
class << self
|
@@ -3333,7 +3333,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3333
3333
|
# @return [String] the expanded macro data
|
3334
3334
|
# @see find_or_create
|
3335
3335
|
#
|
3336
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3336
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#119
|
3337
3337
|
def apply(docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil), _method_object = T.unsafe(nil)); end
|
3338
3338
|
|
3339
3339
|
# Applies a macro to a docstring, interpolating the macro's data on the
|
@@ -3349,7 +3349,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3349
3349
|
# interpolating the block data as a variable.
|
3350
3350
|
# @return [String] the expanded macro data
|
3351
3351
|
#
|
3352
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3352
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#135
|
3353
3353
|
def apply_macro(macro, docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3354
3354
|
|
3355
3355
|
# Creates a new macro and fills in the relevant properties.
|
@@ -3360,7 +3360,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3360
3360
|
# macro to. If supplied, {#attached?} will be true
|
3361
3361
|
# @return [MacroObject] the newly created object
|
3362
3362
|
#
|
3363
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3363
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#39
|
3364
3364
|
def create(macro_name, data, method_object = T.unsafe(nil)); end
|
3365
3365
|
|
3366
3366
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3380,7 +3380,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3380
3380
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3381
3381
|
# not new and no macro by the macro name is found.
|
3382
3382
|
#
|
3383
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3383
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3384
3384
|
def create_docstring(macro_name, data, method_object = T.unsafe(nil)); end
|
3385
3385
|
|
3386
3386
|
# Expands +macro_data+ using the interpolation parameters.
|
@@ -3393,7 +3393,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3393
3393
|
#
|
3394
3394
|
# @param macro_data [String] the macro data to expand (taken from {#macro_data})
|
3395
3395
|
#
|
3396
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3396
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#92
|
3397
3397
|
def expand(macro_data, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3398
3398
|
|
3399
3399
|
# Finds a macro using +macro_name+
|
@@ -3402,7 +3402,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3402
3402
|
# @return [MacroObject] if a macro is found
|
3403
3403
|
# @return [nil] if there is no registered macro by that name
|
3404
3404
|
#
|
3405
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3405
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#50
|
3406
3406
|
def find(macro_name); end
|
3407
3407
|
|
3408
3408
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3422,12 +3422,12 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3422
3422
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3423
3423
|
# not new and no macro by the macro name is found.
|
3424
3424
|
#
|
3425
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3425
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3426
3426
|
def find_or_create(macro_name, data, method_object = T.unsafe(nil)); end
|
3427
3427
|
end
|
3428
3428
|
end
|
3429
3429
|
|
3430
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3430
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#30
|
3431
3431
|
YARD::CodeObjects::MacroObject::MACRO_MATCH = T.let(T.unsafe(nil), Regexp)
|
3432
3432
|
|
3433
3433
|
# Represents a Ruby method in source
|
@@ -4762,7 +4762,7 @@ YARD::Docstring::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
|
4762
4762
|
# @see #parse_content
|
4763
4763
|
# @since 0.8.0
|
4764
4764
|
#
|
4765
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4765
|
+
# source://yard//lib/yard/docstring_parser.rb#29
|
4766
4766
|
class YARD::DocstringParser
|
4767
4767
|
# Creates a new parser to parse docstring data
|
4768
4768
|
#
|
@@ -4771,7 +4771,7 @@ class YARD::DocstringParser
|
|
4771
4771
|
# @return [DocstringParser] a new instance of DocstringParser
|
4772
4772
|
# @since 0.8.0
|
4773
4773
|
#
|
4774
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4774
|
+
# source://yard//lib/yard/docstring_parser.rb#80
|
4775
4775
|
def initialize(library = T.unsafe(nil)); end
|
4776
4776
|
|
4777
4777
|
# Creates a new directive using the registered {#library}
|
@@ -4779,14 +4779,14 @@ class YARD::DocstringParser
|
|
4779
4779
|
# @return [Tags::Directive] the directive object that is created
|
4780
4780
|
# @since 0.8.0
|
4781
4781
|
#
|
4782
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4782
|
+
# source://yard//lib/yard/docstring_parser.rb#231
|
4783
4783
|
def create_directive(tag_name, tag_buf); end
|
4784
4784
|
|
4785
4785
|
# Creates a {Tags::RefTag}
|
4786
4786
|
#
|
4787
4787
|
# @since 0.8.0
|
4788
4788
|
#
|
4789
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4789
|
+
# source://yard//lib/yard/docstring_parser.rb#225
|
4790
4790
|
def create_ref_tag(tag_name, name, object_name); end
|
4791
4791
|
|
4792
4792
|
# Creates a tag from the {Tags::DefaultFactory tag factory}.
|
@@ -4798,7 +4798,7 @@ class YARD::DocstringParser
|
|
4798
4798
|
# @return [Tags::Tag, Tags::RefTag] a tag
|
4799
4799
|
# @since 0.8.0
|
4800
4800
|
#
|
4801
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4801
|
+
# source://yard//lib/yard/docstring_parser.rb#208
|
4802
4802
|
def create_tag(tag_name, tag_buf = T.unsafe(nil)); end
|
4803
4803
|
|
4804
4804
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4806,7 +4806,7 @@ class YARD::DocstringParser
|
|
4806
4806
|
# Docstring object.
|
4807
4807
|
# @since 0.8.0
|
4808
4808
|
#
|
4809
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4809
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4810
4810
|
def directives; end
|
4811
4811
|
|
4812
4812
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4814,7 +4814,7 @@ class YARD::DocstringParser
|
|
4814
4814
|
# Docstring object.
|
4815
4815
|
# @since 0.8.0
|
4816
4816
|
#
|
4817
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4817
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4818
4818
|
def directives=(_arg0); end
|
4819
4819
|
|
4820
4820
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4822,7 +4822,7 @@ class YARD::DocstringParser
|
|
4822
4822
|
# initialized through
|
4823
4823
|
# @since 0.8.0
|
4824
4824
|
#
|
4825
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4825
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4826
4826
|
def handler; end
|
4827
4827
|
|
4828
4828
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4830,21 +4830,21 @@ class YARD::DocstringParser
|
|
4830
4830
|
# initialized through
|
4831
4831
|
# @since 0.8.0
|
4832
4832
|
#
|
4833
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4833
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4834
4834
|
def handler=(_arg0); end
|
4835
4835
|
|
4836
4836
|
# @return [Tags::Library] the tag library being used to
|
4837
4837
|
# identify registered tags in the docstring.
|
4838
4838
|
# @since 0.8.0
|
4839
4839
|
#
|
4840
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4840
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4841
4841
|
def library; end
|
4842
4842
|
|
4843
4843
|
# @return [Tags::Library] the tag library being used to
|
4844
4844
|
# identify registered tags in the docstring.
|
4845
4845
|
# @since 0.8.0
|
4846
4846
|
#
|
4847
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4847
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4848
4848
|
def library=(_arg0); end
|
4849
4849
|
|
4850
4850
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4852,7 +4852,7 @@ class YARD::DocstringParser
|
|
4852
4852
|
# not attached to any object.
|
4853
4853
|
# @since 0.8.0
|
4854
4854
|
#
|
4855
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4855
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4856
4856
|
def object; end
|
4857
4857
|
|
4858
4858
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4860,7 +4860,7 @@ class YARD::DocstringParser
|
|
4860
4860
|
# not attached to any object.
|
4861
4861
|
# @since 0.8.0
|
4862
4862
|
#
|
4863
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4863
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4864
4864
|
def object=(_arg0); end
|
4865
4865
|
|
4866
4866
|
# Parses all content and returns itself.
|
@@ -4877,7 +4877,7 @@ class YARD::DocstringParser
|
|
4877
4877
|
# @see #to_docstring
|
4878
4878
|
# @since 0.8.0
|
4879
4879
|
#
|
4880
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4880
|
+
# source://yard//lib/yard/docstring_parser.rb#112
|
4881
4881
|
def parse(content, object = T.unsafe(nil), handler = T.unsafe(nil)); end
|
4882
4882
|
|
4883
4883
|
# Parses a given block of text.
|
@@ -4887,7 +4887,7 @@ class YARD::DocstringParser
|
|
4887
4887
|
# @param content [String] the content to parse
|
4888
4888
|
# @since 0.8.0
|
4889
4889
|
#
|
4890
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4890
|
+
# source://yard//lib/yard/docstring_parser.rb#128
|
4891
4891
|
def parse_content(content); end
|
4892
4892
|
|
4893
4893
|
# Call post processing callbacks on parser.
|
@@ -4897,19 +4897,19 @@ class YARD::DocstringParser
|
|
4897
4897
|
# @return [void]
|
4898
4898
|
# @since 0.8.0
|
4899
4899
|
#
|
4900
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4900
|
+
# source://yard//lib/yard/docstring_parser.rb#195
|
4901
4901
|
def post_process; end
|
4902
4902
|
|
4903
4903
|
# @return [String] the complete input string to the parser.
|
4904
4904
|
# @since 0.8.0
|
4905
4905
|
#
|
4906
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4906
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4907
4907
|
def raw_text; end
|
4908
4908
|
|
4909
4909
|
# @return [String] the complete input string to the parser.
|
4910
4910
|
# @since 0.8.0
|
4911
4911
|
#
|
4912
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4912
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4913
4913
|
def raw_text=(_arg0); end
|
4914
4914
|
|
4915
4915
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4917,7 +4917,7 @@ class YARD::DocstringParser
|
|
4917
4917
|
# refer to any object.
|
4918
4918
|
# @since 0.8.0
|
4919
4919
|
#
|
4920
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4920
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4921
4921
|
def reference; end
|
4922
4922
|
|
4923
4923
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4925,7 +4925,7 @@ class YARD::DocstringParser
|
|
4925
4925
|
# refer to any object.
|
4926
4926
|
# @since 0.8.0
|
4927
4927
|
#
|
4928
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4928
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4929
4929
|
def reference=(_arg0); end
|
4930
4930
|
|
4931
4931
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4934,7 +4934,7 @@ class YARD::DocstringParser
|
|
4934
4934
|
# used in a docstring).
|
4935
4935
|
# @since 0.8.0
|
4936
4936
|
#
|
4937
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4937
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4938
4938
|
def state; end
|
4939
4939
|
|
4940
4940
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4943,7 +4943,7 @@ class YARD::DocstringParser
|
|
4943
4943
|
# used in a docstring).
|
4944
4944
|
# @since 0.8.0
|
4945
4945
|
#
|
4946
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4946
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4947
4947
|
def state=(_arg0); end
|
4948
4948
|
|
4949
4949
|
# Backward compatibility to detect old tags that should be specified
|
@@ -4952,42 +4952,42 @@ class YARD::DocstringParser
|
|
4952
4952
|
# @return [Boolean]
|
4953
4953
|
# @since 0.8.0
|
4954
4954
|
#
|
4955
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4955
|
+
# source://yard//lib/yard/docstring_parser.rb#251
|
4956
4956
|
def tag_is_directive?(tag_name); end
|
4957
4957
|
|
4958
4958
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4959
4959
|
# by the parser
|
4960
4960
|
# @since 0.8.0
|
4961
4961
|
#
|
4962
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4962
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4963
4963
|
def tags; end
|
4964
4964
|
|
4965
4965
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4966
4966
|
# by the parser
|
4967
4967
|
# @since 0.8.0
|
4968
4968
|
#
|
4969
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4969
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4970
4970
|
def tags=(_arg0); end
|
4971
4971
|
|
4972
4972
|
# @return [String] the parsed text portion of the docstring,
|
4973
4973
|
# with tags removed.
|
4974
4974
|
# @since 0.8.0
|
4975
4975
|
#
|
4976
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4976
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4977
4977
|
def text; end
|
4978
4978
|
|
4979
4979
|
# @return [String] the parsed text portion of the docstring,
|
4980
4980
|
# with tags removed.
|
4981
4981
|
# @since 0.8.0
|
4982
4982
|
#
|
4983
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4983
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4984
4984
|
def text=(_arg0); end
|
4985
4985
|
|
4986
4986
|
# @return [Docstring] translates parsed text into
|
4987
4987
|
# a Docstring object.
|
4988
4988
|
# @since 0.8.0
|
4989
4989
|
#
|
4990
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4990
|
+
# source://yard//lib/yard/docstring_parser.rb#94
|
4991
4991
|
def to_docstring; end
|
4992
4992
|
|
4993
4993
|
private
|
@@ -4996,7 +4996,7 @@ class YARD::DocstringParser
|
|
4996
4996
|
#
|
4997
4997
|
# @since 0.8.0
|
4998
4998
|
#
|
4999
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4999
|
+
# source://yard//lib/yard/docstring_parser.rb#323
|
5000
5000
|
def call_after_parse_callbacks; end
|
5001
5001
|
|
5002
5002
|
# Calls the {Tags::Directive#after_parse} callback on all the
|
@@ -5004,17 +5004,17 @@ class YARD::DocstringParser
|
|
5004
5004
|
#
|
5005
5005
|
# @since 0.8.0
|
5006
5006
|
#
|
5007
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5007
|
+
# source://yard//lib/yard/docstring_parser.rb#318
|
5008
5008
|
def call_directives_after_parse; end
|
5009
5009
|
|
5010
5010
|
# @since 0.8.0
|
5011
5011
|
#
|
5012
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5012
|
+
# source://yard//lib/yard/docstring_parser.rb#304
|
5013
5013
|
def detect_reference(content); end
|
5014
5014
|
|
5015
5015
|
# @since 0.8.0
|
5016
5016
|
#
|
5017
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5017
|
+
# source://yard//lib/yard/docstring_parser.rb#300
|
5018
5018
|
def namespace; end
|
5019
5019
|
|
5020
5020
|
class << self
|
@@ -5029,13 +5029,13 @@ class YARD::DocstringParser
|
|
5029
5029
|
# with all directives and tags created.
|
5030
5030
|
# @yieldreturn [void]
|
5031
5031
|
#
|
5032
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5032
|
+
# source://yard//lib/yard/docstring_parser.rb#265
|
5033
5033
|
def after_parse(&block); end
|
5034
5034
|
|
5035
5035
|
# @return [Array<Proc>] the {after_parse} callback proc objects
|
5036
5036
|
# @since 0.8.0
|
5037
5037
|
#
|
5038
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5038
|
+
# source://yard//lib/yard/docstring_parser.rb#270
|
5039
5039
|
def after_parse_callbacks; end
|
5040
5040
|
end
|
5041
5041
|
end
|
@@ -5044,7 +5044,7 @@ end
|
|
5044
5044
|
#
|
5045
5045
|
# @since 0.8.0
|
5046
5046
|
#
|
5047
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5047
|
+
# source://yard//lib/yard/docstring_parser.rb#72
|
5048
5048
|
YARD::DocstringParser::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
5049
5049
|
|
5050
5050
|
# source://yard//lib/yard/gem_index.rb#6
|
@@ -5953,14 +5953,14 @@ end
|
|
5953
5953
|
#
|
5954
5954
|
# @see Handlers::Base
|
5955
5955
|
#
|
5956
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5956
|
+
# source://yard//lib/yard/handlers/processor.rb#19
|
5957
5957
|
class YARD::Handlers::Processor
|
5958
5958
|
# Creates a new Processor for a +file+.
|
5959
5959
|
#
|
5960
5960
|
# @param parser [Parser::SourceParser] the parser used to initialize the processor
|
5961
5961
|
# @return [Processor] a new instance of Processor
|
5962
5962
|
#
|
5963
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5963
|
+
# source://yard//lib/yard/handlers/processor.rb#91
|
5964
5964
|
def initialize(parser); end
|
5965
5965
|
|
5966
5966
|
# Share state across different handlers inside of a file.
|
@@ -5973,7 +5973,7 @@ class YARD::Handlers::Processor
|
|
5973
5973
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5974
5974
|
# @see #globals
|
5975
5975
|
#
|
5976
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5976
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5977
5977
|
def extra_state; end
|
5978
5978
|
|
5979
5979
|
# Share state across different handlers inside of a file.
|
@@ -5986,17 +5986,17 @@ class YARD::Handlers::Processor
|
|
5986
5986
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5987
5987
|
# @see #globals
|
5988
5988
|
#
|
5989
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5989
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5990
5990
|
def extra_state=(_arg0); end
|
5991
5991
|
|
5992
5992
|
# @return [String] the filename
|
5993
5993
|
#
|
5994
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5994
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
5995
5995
|
def file; end
|
5996
5996
|
|
5997
5997
|
# @return [String] the filename
|
5998
5998
|
#
|
5999
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5999
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
6000
6000
|
def file=(_arg0); end
|
6001
6001
|
|
6002
6002
|
# Searches for all handlers in {Base.subclasses} that match the +statement+
|
@@ -6004,7 +6004,7 @@ class YARD::Handlers::Processor
|
|
6004
6004
|
# @param statement the statement object to match.
|
6005
6005
|
# @return [Array<Base>] a list of handlers to process the statement with.
|
6006
6006
|
#
|
6007
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6007
|
+
# source://yard//lib/yard/handlers/processor.rb#150
|
6008
6008
|
def find_handlers(statement); end
|
6009
6009
|
|
6010
6010
|
# Handlers can share state for the entire post processing stage through
|
@@ -6024,7 +6024,7 @@ class YARD::Handlers::Processor
|
|
6024
6024
|
# @return [OpenStruct] global shared state for post-processing stage
|
6025
6025
|
# @see #extra_state
|
6026
6026
|
#
|
6027
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6027
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6028
6028
|
def globals; end
|
6029
6029
|
|
6030
6030
|
# Handlers can share state for the entire post processing stage through
|
@@ -6044,17 +6044,17 @@ class YARD::Handlers::Processor
|
|
6044
6044
|
# @return [OpenStruct] global shared state for post-processing stage
|
6045
6045
|
# @see #extra_state
|
6046
6046
|
#
|
6047
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6047
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6048
6048
|
def globals=(_arg0); end
|
6049
6049
|
|
6050
6050
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6051
6051
|
#
|
6052
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6052
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6053
6053
|
def namespace; end
|
6054
6054
|
|
6055
6055
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6056
6056
|
#
|
6057
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6057
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6058
6058
|
def namespace=(_arg0); end
|
6059
6059
|
|
6060
6060
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6062,7 +6062,7 @@ class YARD::Handlers::Processor
|
|
6062
6062
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6063
6063
|
# is set as the owner, in case any extra method information is processed.
|
6064
6064
|
#
|
6065
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6065
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6066
6066
|
def owner; end
|
6067
6067
|
|
6068
6068
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6070,7 +6070,7 @@ class YARD::Handlers::Processor
|
|
6070
6070
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6071
6071
|
# is set as the owner, in case any extra method information is processed.
|
6072
6072
|
#
|
6073
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6073
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6074
6074
|
def owner=(_arg0); end
|
6075
6075
|
|
6076
6076
|
# Continue parsing the remainder of the files in the +globals.ordered_parser+
|
@@ -6080,17 +6080,17 @@ class YARD::Handlers::Processor
|
|
6080
6080
|
# @return [void]
|
6081
6081
|
# @see Parser::OrderedParser
|
6082
6082
|
#
|
6083
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6083
|
+
# source://yard//lib/yard/handlers/processor.rb#139
|
6084
6084
|
def parse_remaining_files; end
|
6085
6085
|
|
6086
6086
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6087
6087
|
#
|
6088
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6088
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6089
6089
|
def parser_type; end
|
6090
6090
|
|
6091
6091
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6092
6092
|
#
|
6093
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6093
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6094
6094
|
def parser_type=(_arg0); end
|
6095
6095
|
|
6096
6096
|
# Processes a list of statements by finding handlers to process each
|
@@ -6099,27 +6099,27 @@ class YARD::Handlers::Processor
|
|
6099
6099
|
# @param statements [Array] a list of statements
|
6100
6100
|
# @return [void]
|
6101
6101
|
#
|
6102
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6102
|
+
# source://yard//lib/yard/handlers/processor.rb#109
|
6103
6103
|
def process(statements); end
|
6104
6104
|
|
6105
6105
|
# @return [Symbol] the current scope (class, instance)
|
6106
6106
|
#
|
6107
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6107
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6108
6108
|
def scope; end
|
6109
6109
|
|
6110
6110
|
# @return [Symbol] the current scope (class, instance)
|
6111
6111
|
#
|
6112
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6112
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6113
6113
|
def scope=(_arg0); end
|
6114
6114
|
|
6115
6115
|
# @return [Symbol] the current visibility (public, private, protected)
|
6116
6116
|
#
|
6117
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6117
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6118
6118
|
def visibility; end
|
6119
6119
|
|
6120
6120
|
# @return [Symbol] the current visibility (public, private, protected)
|
6121
6121
|
#
|
6122
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6122
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6123
6123
|
def visibility=(_arg0); end
|
6124
6124
|
|
6125
6125
|
private
|
@@ -6128,7 +6128,7 @@ class YARD::Handlers::Processor
|
|
6128
6128
|
#
|
6129
6129
|
# @return [Base] the base class
|
6130
6130
|
#
|
6131
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6131
|
+
# source://yard//lib/yard/handlers/processor.rb#171
|
6132
6132
|
def handler_base_class; end
|
6133
6133
|
|
6134
6134
|
# The module holding the handlers to be loaded
|
@@ -6136,12 +6136,12 @@ class YARD::Handlers::Processor
|
|
6136
6136
|
# @return [Module] the module containing the handlers depending on
|
6137
6137
|
# {#parser_type}.
|
6138
6138
|
#
|
6139
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6139
|
+
# source://yard//lib/yard/handlers/processor.rb#179
|
6140
6140
|
def handler_base_namespace; end
|
6141
6141
|
|
6142
6142
|
# @return [Boolean]
|
6143
6143
|
#
|
6144
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6144
|
+
# source://yard//lib/yard/handlers/processor.rb#160
|
6145
6145
|
def handles?(handler, statement); end
|
6146
6146
|
|
6147
6147
|
# Loads handlers from {#handler_base_namespace}. This ensures that
|
@@ -6150,7 +6150,7 @@ class YARD::Handlers::Processor
|
|
6150
6150
|
#
|
6151
6151
|
# @return [void]
|
6152
6152
|
#
|
6153
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6153
|
+
# source://yard//lib/yard/handlers/processor.rb#187
|
6154
6154
|
def load_handlers; end
|
6155
6155
|
|
6156
6156
|
class << self
|
@@ -6158,14 +6158,14 @@ class YARD::Handlers::Processor
|
|
6158
6158
|
# @return [Hash] a list of registered parser type extensions
|
6159
6159
|
# @since 0.6.0
|
6160
6160
|
#
|
6161
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6161
|
+
# source://yard//lib/yard/handlers/processor.rb#32
|
6162
6162
|
def namespace_for_handler; end
|
6163
6163
|
|
6164
6164
|
# Registers a new namespace for handlers of the given type.
|
6165
6165
|
#
|
6166
6166
|
# @since 0.6.0
|
6167
6167
|
#
|
6168
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6168
|
+
# source://yard//lib/yard/handlers/processor.rb#23
|
6169
6169
|
def register_handler_namespace(type, ns); end
|
6170
6170
|
end
|
6171
6171
|
end
|
@@ -6998,6 +6998,11 @@ end
|
|
6998
6998
|
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#3
|
6999
6999
|
class YARD::Handlers::Ruby::VisibilityHandler < ::YARD::Handlers::Ruby::Base
|
7000
7000
|
include ::YARD::Handlers::Ruby::DecoratorHandlerMethods
|
7001
|
+
|
7002
|
+
# @return [Boolean]
|
7003
|
+
#
|
7004
|
+
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#31
|
7005
|
+
def is_attribute_method?(node); end
|
7001
7006
|
end
|
7002
7007
|
|
7003
7008
|
# Handles 'yield' calls
|
@@ -7460,13 +7465,16 @@ end
|
|
7460
7465
|
# Handles console logging for info, warnings and errors.
|
7461
7466
|
# Uses the stdlib Logger class in Ruby for all the backend logic.
|
7462
7467
|
#
|
7463
|
-
# source://yard//lib/yard/logging.rb#
|
7464
|
-
class YARD::Logger
|
7468
|
+
# source://yard//lib/yard/logging.rb#8
|
7469
|
+
class YARD::Logger
|
7470
|
+
include ::YARD::Logger::Severity
|
7471
|
+
|
7465
7472
|
# Creates a new logger
|
7466
7473
|
#
|
7474
|
+
# @private
|
7467
7475
|
# @return [Logger] a new instance of Logger
|
7468
7476
|
#
|
7469
|
-
# source://yard//lib/yard/logging.rb#
|
7477
|
+
# source://yard//lib/yard/logging.rb#82
|
7470
7478
|
def initialize(pipe, *args); end
|
7471
7479
|
|
7472
7480
|
# Displays an unformatted line to the logger output stream.
|
@@ -7475,7 +7483,7 @@ class YARD::Logger < ::Logger
|
|
7475
7483
|
# @return [void]
|
7476
7484
|
# @since 0.8.2
|
7477
7485
|
#
|
7478
|
-
# source://yard//lib/yard/logging.rb#
|
7486
|
+
# source://yard//lib/yard/logging.rb#205
|
7479
7487
|
def <<(msg = T.unsafe(nil)); end
|
7480
7488
|
|
7481
7489
|
# Prints the backtrace +exc+ to the logger as error data.
|
@@ -7484,7 +7492,7 @@ class YARD::Logger < ::Logger
|
|
7484
7492
|
# @param level_meth [Symbol] the level to log backtrace at
|
7485
7493
|
# @return [void]
|
7486
7494
|
#
|
7487
|
-
# source://yard//lib/yard/logging.rb#
|
7495
|
+
# source://yard//lib/yard/logging.rb#216
|
7488
7496
|
def backtrace(exc, level_meth = T.unsafe(nil)); end
|
7489
7497
|
|
7490
7498
|
# Captures the duration of a block of code for benchmark analysis. Also
|
@@ -7497,7 +7505,7 @@ class YARD::Logger < ::Logger
|
|
7497
7505
|
# @todo Implement capture storage for reporting of benchmarks
|
7498
7506
|
# @yield a block of arbitrary code to benchmark
|
7499
7507
|
#
|
7500
|
-
# source://yard//lib/yard/logging.rb#
|
7508
|
+
# source://yard//lib/yard/logging.rb#234
|
7501
7509
|
def capture(msg, nontty_log = T.unsafe(nil)); end
|
7502
7510
|
|
7503
7511
|
# Clears the progress indicator in the TTY display.
|
@@ -7505,14 +7513,18 @@ class YARD::Logger < ::Logger
|
|
7505
7513
|
# @return [void]
|
7506
7514
|
# @since 0.8.2
|
7507
7515
|
#
|
7508
|
-
# source://yard//lib/yard/logging.rb#
|
7516
|
+
# source://yard//lib/yard/logging.rb#186
|
7509
7517
|
def clear_progress; end
|
7510
7518
|
|
7511
|
-
# Changes the debug level to DEBUG if $DEBUG is set
|
7512
|
-
#
|
7519
|
+
# Changes the debug level to DEBUG if $DEBUG is set and writes a debugging message.
|
7520
|
+
# Logs a message with the debug severity level.
|
7513
7521
|
#
|
7514
|
-
#
|
7515
|
-
|
7522
|
+
# @param message [String] the message to log
|
7523
|
+
# @return [void]
|
7524
|
+
# @see #log
|
7525
|
+
#
|
7526
|
+
# source://yard//lib/yard/logging.rb#103
|
7527
|
+
def debug(message); end
|
7516
7528
|
|
7517
7529
|
# Sets the logger level for the duration of the block
|
7518
7530
|
#
|
@@ -7524,17 +7536,65 @@ class YARD::Logger < ::Logger
|
|
7524
7536
|
# values can be found in Ruby's Logger class.
|
7525
7537
|
# @yield the block with the logger temporarily set to +new_level+
|
7526
7538
|
#
|
7527
|
-
# source://yard//lib/yard/logging.rb#
|
7539
|
+
# source://yard//lib/yard/logging.rb#142
|
7528
7540
|
def enter_level(new_level = T.unsafe(nil)); end
|
7529
7541
|
|
7542
|
+
# Logs a message with the error severity level.
|
7543
|
+
#
|
7544
|
+
# @param message [String] the message to log
|
7545
|
+
# @return [void]
|
7546
|
+
# @see #log
|
7547
|
+
#
|
7548
|
+
# source://yard//lib/yard/logging.rb#103
|
7549
|
+
def error(message); end
|
7550
|
+
|
7551
|
+
# Logs a message with the fatal severity level.
|
7552
|
+
#
|
7553
|
+
# @param message [String] the message to log
|
7554
|
+
# @return [void]
|
7555
|
+
# @see #log
|
7556
|
+
#
|
7557
|
+
# source://yard//lib/yard/logging.rb#103
|
7558
|
+
def fatal(message); end
|
7559
|
+
|
7560
|
+
# Logs a message with the info severity level.
|
7561
|
+
#
|
7562
|
+
# @param message [String] the message to log
|
7563
|
+
# @return [void]
|
7564
|
+
# @see #log
|
7565
|
+
#
|
7566
|
+
# source://yard//lib/yard/logging.rb#103
|
7567
|
+
def info(message); end
|
7568
|
+
|
7530
7569
|
# @return [IO] the IO object being logged to
|
7531
7570
|
# @since 0.8.2
|
7532
7571
|
#
|
7533
|
-
# source://yard//lib/yard/logging.rb#
|
7572
|
+
# source://yard//lib/yard/logging.rb#49
|
7534
7573
|
def io; end
|
7535
7574
|
|
7536
|
-
#
|
7537
|
-
|
7575
|
+
# @return [IO] the IO object being logged to
|
7576
|
+
# @since 0.8.2
|
7577
|
+
#
|
7578
|
+
# source://yard//lib/yard/logging.rb#49
|
7579
|
+
def io=(_arg0); end
|
7580
|
+
|
7581
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7582
|
+
#
|
7583
|
+
# source://yard//lib/yard/logging.rb#57
|
7584
|
+
def level; end
|
7585
|
+
|
7586
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7587
|
+
#
|
7588
|
+
# source://yard//lib/yard/logging.rb#57
|
7589
|
+
def level=(_arg0); end
|
7590
|
+
|
7591
|
+
# Logs a message with a given severity
|
7592
|
+
#
|
7593
|
+
# @param severity [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the severity level
|
7594
|
+
# @param message [String] the message to log
|
7595
|
+
#
|
7596
|
+
# source://yard//lib/yard/logging.rb#122
|
7597
|
+
def log(severity, message); end
|
7538
7598
|
|
7539
7599
|
# Displays an unformatted line to the logger output stream.
|
7540
7600
|
#
|
@@ -7542,7 +7602,7 @@ class YARD::Logger < ::Logger
|
|
7542
7602
|
# @return [void]
|
7543
7603
|
# @since 0.8.2
|
7544
7604
|
#
|
7545
|
-
# source://yard//lib/yard/logging.rb#
|
7605
|
+
# source://yard//lib/yard/logging.rb#205
|
7546
7606
|
def print(msg = T.unsafe(nil)); end
|
7547
7607
|
|
7548
7608
|
# Displays a progress indicator for a given message. This progress report
|
@@ -7555,7 +7615,7 @@ class YARD::Logger < ::Logger
|
|
7555
7615
|
# @return [void]
|
7556
7616
|
# @since 0.8.2
|
7557
7617
|
#
|
7558
|
-
# source://yard//lib/yard/logging.rb#
|
7618
|
+
# source://yard//lib/yard/logging.rb#161
|
7559
7619
|
def progress(msg, nontty_log = T.unsafe(nil)); end
|
7560
7620
|
|
7561
7621
|
# Displays an unformatted line to the logger output stream, adding
|
@@ -7565,86 +7625,91 @@ class YARD::Logger < ::Logger
|
|
7565
7625
|
# @return [void]
|
7566
7626
|
# @since 0.8.2
|
7567
7627
|
#
|
7568
|
-
# source://yard//lib/yard/logging.rb#
|
7628
|
+
# source://yard//lib/yard/logging.rb#197
|
7569
7629
|
def puts(msg = T.unsafe(nil)); end
|
7570
7630
|
|
7571
7631
|
# @return [Boolean] whether backtraces should be shown (by default
|
7572
7632
|
# this is on).
|
7573
7633
|
#
|
7574
|
-
# source://yard//lib/yard/logging.rb#
|
7634
|
+
# source://yard//lib/yard/logging.rb#53
|
7575
7635
|
def show_backtraces; end
|
7576
7636
|
|
7577
7637
|
# Sets the attribute show_backtraces
|
7578
7638
|
#
|
7579
7639
|
# @param value the value to set the attribute show_backtraces to.
|
7580
7640
|
#
|
7581
|
-
# source://yard//lib/yard/logging.rb#
|
7641
|
+
# source://yard//lib/yard/logging.rb#54
|
7582
7642
|
def show_backtraces=(_arg0); end
|
7583
7643
|
|
7584
7644
|
# @return [Boolean] whether progress indicators should be shown when
|
7585
7645
|
# logging CLIs (by default this is off).
|
7586
7646
|
#
|
7587
|
-
# source://yard//lib/yard/logging.rb#
|
7647
|
+
# source://yard//lib/yard/logging.rb#64
|
7588
7648
|
def show_progress; end
|
7589
7649
|
|
7590
7650
|
# Sets the attribute show_progress
|
7591
7651
|
#
|
7592
7652
|
# @param value the value to set the attribute show_progress to.
|
7593
7653
|
#
|
7594
|
-
# source://yard//lib/yard/logging.rb#
|
7654
|
+
# source://yard//lib/yard/logging.rb#70
|
7595
7655
|
def show_progress=(_arg0); end
|
7596
7656
|
|
7657
|
+
# Logs a message with the unknown severity level.
|
7658
|
+
#
|
7659
|
+
# @param message [String] the message to log
|
7660
|
+
# @return [void]
|
7661
|
+
# @see #log
|
7662
|
+
#
|
7663
|
+
# source://yard//lib/yard/logging.rb#103
|
7664
|
+
def unknown(message); end
|
7665
|
+
|
7597
7666
|
# Remembers when a warning occurs and writes a warning message.
|
7667
|
+
# Logs a message with the warn severity level.
|
7598
7668
|
#
|
7599
|
-
#
|
7600
|
-
|
7669
|
+
# @param message [String] the message to log
|
7670
|
+
# @return [void]
|
7671
|
+
# @see #log
|
7672
|
+
#
|
7673
|
+
# source://yard//lib/yard/logging.rb#103
|
7674
|
+
def warn(message); end
|
7601
7675
|
|
7602
7676
|
# Warns that the Ruby environment does not support continuations. Applies
|
7603
7677
|
# to JRuby, Rubinius and MacRuby. This warning will only display once
|
7604
7678
|
# per Ruby process.
|
7605
7679
|
#
|
7606
7680
|
# @deprecated Continuations are no longer needed by YARD 0.8.0+.
|
7681
|
+
# @private
|
7607
7682
|
# @return [void]
|
7608
7683
|
#
|
7609
|
-
# source://yard//lib/yard/logging.rb#
|
7684
|
+
# source://yard//lib/yard/logging.rb#250
|
7610
7685
|
def warn_no_continuations; end
|
7611
7686
|
|
7612
|
-
#
|
7687
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7613
7688
|
#
|
7614
|
-
# source://yard//lib/yard/logging.rb#
|
7689
|
+
# source://yard//lib/yard/logging.rb#60
|
7615
7690
|
def warned; end
|
7616
7691
|
|
7617
|
-
#
|
7692
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7618
7693
|
#
|
7619
|
-
#
|
7620
|
-
#
|
7621
|
-
# source://yard//lib/yard/logging.rb#69
|
7694
|
+
# source://yard//lib/yard/logging.rb#60
|
7622
7695
|
def warned=(_arg0); end
|
7623
7696
|
|
7624
7697
|
private
|
7625
7698
|
|
7626
|
-
#
|
7627
|
-
#
|
7628
|
-
# source://yard//lib/yard/logging.rb#190
|
7629
|
-
def add(*args); end
|
7630
|
-
|
7631
|
-
# source://yard//lib/yard/logging.rb#195
|
7699
|
+
# source://yard//lib/yard/logging.rb#255
|
7632
7700
|
def clear_line; end
|
7633
7701
|
|
7634
|
-
# Log format (from Logger implementation). Used by Logger internally
|
7635
|
-
#
|
7636
|
-
# source://yard//lib/yard/logging.rb#201
|
7637
|
-
def format_log(sev, _time, _prog, msg); end
|
7638
|
-
|
7639
|
-
# source://logger/1.5.3/logger.rb#682
|
7640
|
-
def print_no_newline(msg); end
|
7641
|
-
|
7642
7702
|
class << self
|
7703
|
+
# @private
|
7704
|
+
#
|
7705
|
+
# source://yard//lib/yard/logging.rb#101
|
7706
|
+
def create_log_method(name); end
|
7707
|
+
|
7643
7708
|
# The logger instance
|
7644
7709
|
#
|
7645
7710
|
# @return [Logger] the logger instance
|
7646
7711
|
#
|
7647
|
-
# source://yard//lib/yard/logging.rb#
|
7712
|
+
# source://yard//lib/yard/logging.rb#76
|
7648
7713
|
def instance(pipe = T.unsafe(nil)); end
|
7649
7714
|
end
|
7650
7715
|
end
|
@@ -7654,9 +7719,97 @@ end
|
|
7654
7719
|
#
|
7655
7720
|
# @since 0.8.2
|
7656
7721
|
#
|
7657
|
-
# source://yard//lib/yard/logging.rb#
|
7722
|
+
# source://yard//lib/yard/logging.rb#45
|
7658
7723
|
YARD::Logger::PROGRESS_INDICATORS = T.let(T.unsafe(nil), Array)
|
7659
7724
|
|
7725
|
+
# Log severity levels
|
7726
|
+
#
|
7727
|
+
# source://yard//lib/yard/logging.rb#10
|
7728
|
+
module YARD::Logger::Severity; end
|
7729
|
+
|
7730
|
+
# Debugging log level
|
7731
|
+
#
|
7732
|
+
# source://yard//lib/yard/logging.rb#12
|
7733
|
+
YARD::Logger::Severity::DEBUG = T.let(T.unsafe(nil), Integer)
|
7734
|
+
|
7735
|
+
# Error log level
|
7736
|
+
#
|
7737
|
+
# source://yard//lib/yard/logging.rb#21
|
7738
|
+
YARD::Logger::Severity::ERROR = T.let(T.unsafe(nil), Integer)
|
7739
|
+
|
7740
|
+
# Fatal log level
|
7741
|
+
#
|
7742
|
+
# source://yard//lib/yard/logging.rb#24
|
7743
|
+
YARD::Logger::Severity::FATAL = T.let(T.unsafe(nil), Integer)
|
7744
|
+
|
7745
|
+
# Information log level
|
7746
|
+
#
|
7747
|
+
# source://yard//lib/yard/logging.rb#15
|
7748
|
+
YARD::Logger::Severity::INFO = T.let(T.unsafe(nil), Integer)
|
7749
|
+
|
7750
|
+
# @private
|
7751
|
+
#
|
7752
|
+
# source://yard//lib/yard/logging.rb#30
|
7753
|
+
YARD::Logger::Severity::SEVERITIES = T.let(T.unsafe(nil), Hash)
|
7754
|
+
|
7755
|
+
# Unknown log level
|
7756
|
+
#
|
7757
|
+
# source://yard//lib/yard/logging.rb#27
|
7758
|
+
YARD::Logger::Severity::UNKNOWN = T.let(T.unsafe(nil), Integer)
|
7759
|
+
|
7760
|
+
# Warning log level
|
7761
|
+
#
|
7762
|
+
# source://yard//lib/yard/logging.rb#18
|
7763
|
+
YARD::Logger::Severity::WARN = T.let(T.unsafe(nil), Integer)
|
7764
|
+
|
7765
|
+
# An OpenStruct compatible struct class that allows for basic access of attributes
|
7766
|
+
# via +struct.attr_name+ and +struct.attr_name = value+.
|
7767
|
+
#
|
7768
|
+
# source://yard//lib/yard/open_struct.rb#4
|
7769
|
+
class YARD::OpenStruct
|
7770
|
+
# @return [OpenStruct] a new instance of OpenStruct
|
7771
|
+
#
|
7772
|
+
# source://yard//lib/yard/open_struct.rb#5
|
7773
|
+
def initialize(hash = T.unsafe(nil)); end
|
7774
|
+
|
7775
|
+
# source://yard//lib/yard/open_struct.rb#25
|
7776
|
+
def ==(other); end
|
7777
|
+
|
7778
|
+
# source://yard//lib/yard/open_struct.rb#41
|
7779
|
+
def [](key); end
|
7780
|
+
|
7781
|
+
# source://yard//lib/yard/open_struct.rb#37
|
7782
|
+
def []=(key, value); end
|
7783
|
+
|
7784
|
+
# source://yard//lib/yard/open_struct.rb#33
|
7785
|
+
def dig(*keys); end
|
7786
|
+
|
7787
|
+
# source://yard//lib/yard/open_struct.rb#45
|
7788
|
+
def each_pair(&block); end
|
7789
|
+
|
7790
|
+
# source://yard//lib/yard/open_struct.rb#29
|
7791
|
+
def hash; end
|
7792
|
+
|
7793
|
+
# source://yard//lib/yard/open_struct.rb#49
|
7794
|
+
def marshal_dump; end
|
7795
|
+
|
7796
|
+
# source://yard//lib/yard/open_struct.rb#53
|
7797
|
+
def marshal_load(data); end
|
7798
|
+
|
7799
|
+
# @private
|
7800
|
+
#
|
7801
|
+
# source://yard//lib/yard/open_struct.rb#10
|
7802
|
+
def method_missing(name, *args); end
|
7803
|
+
|
7804
|
+
# source://yard//lib/yard/open_struct.rb#21
|
7805
|
+
def to_h; end
|
7806
|
+
|
7807
|
+
private
|
7808
|
+
|
7809
|
+
# source://yard//lib/yard/open_struct.rb#59
|
7810
|
+
def __cache_lookup__(name); end
|
7811
|
+
end
|
7812
|
+
|
7660
7813
|
# Generalized options class for passing around large amounts of options between objects.
|
7661
7814
|
#
|
7662
7815
|
# The options class exists for better visibility and documentability of options being
|
@@ -8208,7 +8361,7 @@ end
|
|
8208
8361
|
#
|
8209
8362
|
# @see Processor#parse_remaining_files
|
8210
8363
|
#
|
8211
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8364
|
+
# source://yard//lib/yard/parser/source_parser.rb#20
|
8212
8365
|
class YARD::Parser::OrderedParser
|
8213
8366
|
# Creates a new OrderedParser with the global state and a list
|
8214
8367
|
# of files to parse.
|
@@ -8220,30 +8373,30 @@ class YARD::Parser::OrderedParser
|
|
8220
8373
|
# @param files [Array<String>] the list of files to parse
|
8221
8374
|
# @return [OrderedParser] a new instance of OrderedParser
|
8222
8375
|
#
|
8223
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8376
|
+
# source://yard//lib/yard/parser/source_parser.rb#32
|
8224
8377
|
def initialize(global_state, files); end
|
8225
8378
|
|
8226
8379
|
# @return [Array<String>] the list of remaining files to parse
|
8227
8380
|
#
|
8228
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8381
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8229
8382
|
def files; end
|
8230
8383
|
|
8231
8384
|
# @return [Array<String>] the list of remaining files to parse
|
8232
8385
|
#
|
8233
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8386
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8234
8387
|
def files=(_arg0); end
|
8235
8388
|
|
8236
8389
|
# Parses the remainder of the {#files} list.
|
8237
8390
|
#
|
8238
8391
|
# @see Processor#parse_remaining_files
|
8239
8392
|
#
|
8240
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8393
|
+
# source://yard//lib/yard/parser/source_parser.rb#41
|
8241
8394
|
def parse; end
|
8242
8395
|
end
|
8243
8396
|
|
8244
8397
|
# Raised when the parser sees a Ruby syntax error
|
8245
8398
|
#
|
8246
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8399
|
+
# source://yard//lib/yard/parser/source_parser.rb#12
|
8247
8400
|
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
|
8248
8401
|
|
8249
8402
|
# Ruby parsing components.
|
@@ -8688,6 +8841,9 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8688
8841
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#430
|
8689
8842
|
def continue; end
|
8690
8843
|
|
8844
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1116
|
8845
|
+
def dedent(str); end
|
8846
|
+
|
8691
8847
|
# Returns the value of attribute exception_on_syntax_error.
|
8692
8848
|
#
|
8693
8849
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#463
|
@@ -8712,7 +8868,7 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8712
8868
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#488
|
8713
8869
|
def gets; end
|
8714
8870
|
|
8715
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8871
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1272
|
8716
8872
|
def identify_comment; end
|
8717
8873
|
|
8718
8874
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#945
|
@@ -8724,13 +8880,13 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8724
8880
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#980
|
8725
8881
|
def identify_identifier; end
|
8726
8882
|
|
8727
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8883
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1145
|
8728
8884
|
def identify_number(start); end
|
8729
8885
|
|
8730
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8886
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1126
|
8731
8887
|
def identify_quotation(initial_char); end
|
8732
8888
|
|
8733
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8889
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1207
|
8734
8890
|
def identify_string(ltype, quoted = T.unsafe(nil), opener = T.unsafe(nil), initial_char = T.unsafe(nil)); end
|
8735
8891
|
|
8736
8892
|
# Returns the value of attribute indent.
|
@@ -8777,10 +8933,10 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8777
8933
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#462
|
8778
8934
|
def read_auto_clean_up=(_arg0); end
|
8779
8935
|
|
8780
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8936
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1295
|
8781
8937
|
def read_escape; end
|
8782
8938
|
|
8783
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8939
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1257
|
8784
8940
|
def skip_inner_expression; end
|
8785
8941
|
|
8786
8942
|
# Returns the value of attribute skip_space.
|
@@ -9973,7 +10129,7 @@ end
|
|
9973
10129
|
|
9974
10130
|
# source://yard//lib/yard/parser/ruby/ast_node.rb#479
|
9975
10131
|
class YARD::Parser::Ruby::MethodDefinitionNode < ::YARD::Parser::Ruby::AstNode
|
9976
|
-
def block(
|
10132
|
+
def block(n = T.unsafe(nil)); end
|
9977
10133
|
|
9978
10134
|
# @return [Boolean]
|
9979
10135
|
#
|
@@ -10969,7 +11125,7 @@ end
|
|
10969
11125
|
# @see Handlers::Base
|
10970
11126
|
# @see CodeObjects::Base
|
10971
11127
|
#
|
10972
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11128
|
+
# source://yard//lib/yard/parser/source_parser.rb#63
|
10973
11129
|
class YARD::Parser::SourceParser
|
10974
11130
|
# @overload initialize
|
10975
11131
|
# @return [SourceParser] a new instance of SourceParser
|
@@ -11225,7 +11381,7 @@ class YARD::Parser::SourceParser
|
|
11225
11381
|
# {YARD::Logger}
|
11226
11382
|
# @return [void]
|
11227
11383
|
#
|
11228
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11384
|
+
# source://yard//lib/yard/parser/source_parser.rb#99
|
11229
11385
|
def parse(paths = T.unsafe(nil), excluded = T.unsafe(nil), level = T.unsafe(nil)); end
|
11230
11386
|
|
11231
11387
|
# Parses a string +content+
|
@@ -11239,10 +11395,10 @@ class YARD::Parser::SourceParser
|
|
11239
11395
|
|
11240
11396
|
# @return [Symbol] the default parser type (defaults to :ruby)
|
11241
11397
|
#
|
11242
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11398
|
+
# source://yard//lib/yard/parser/source_parser.rb#85
|
11243
11399
|
def parser_type; end
|
11244
11400
|
|
11245
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11401
|
+
# source://yard//lib/yard/parser/source_parser.rb#87
|
11246
11402
|
def parser_type=(value); end
|
11247
11403
|
|
11248
11404
|
# @private
|
@@ -11323,30 +11479,30 @@ end
|
|
11323
11479
|
#
|
11324
11480
|
# @since 0.9.0
|
11325
11481
|
#
|
11326
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11482
|
+
# source://yard//lib/yard/parser/source_parser.rb#70
|
11327
11483
|
YARD::Parser::SourceParser::DEFAULT_PATH_GLOB = T.let(T.unsafe(nil), Array)
|
11328
11484
|
|
11329
11485
|
# Byte order marks for various encodings
|
11330
11486
|
#
|
11331
11487
|
# @since 0.7.0
|
11332
11488
|
#
|
11333
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11489
|
+
# source://yard//lib/yard/parser/source_parser.rb#74
|
11334
11490
|
YARD::Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS = T.let(T.unsafe(nil), Hash)
|
11335
11491
|
|
11336
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11492
|
+
# source://yard//lib/yard/parser/source_parser.rb#65
|
11337
11493
|
YARD::Parser::SourceParser::ENCODING_LINE = T.let(T.unsafe(nil), Regexp)
|
11338
11494
|
|
11339
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11495
|
+
# source://yard//lib/yard/parser/source_parser.rb#66
|
11340
11496
|
YARD::Parser::SourceParser::FROZEN_STRING_LINE = T.let(T.unsafe(nil), Regexp)
|
11341
11497
|
|
11342
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11498
|
+
# source://yard//lib/yard/parser/source_parser.rb#64
|
11343
11499
|
YARD::Parser::SourceParser::SHEBANG_LINE = T.let(T.unsafe(nil), Regexp)
|
11344
11500
|
|
11345
11501
|
# Raised when an object is recognized but cannot be documented. This
|
11346
11502
|
# generally occurs when the Ruby syntax used to declare an object is
|
11347
11503
|
# too dynamic in nature.
|
11348
11504
|
#
|
11349
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11505
|
+
# source://yard//lib/yard/parser/source_parser.rb#9
|
11350
11506
|
class YARD::Parser::UndocumentableError < ::RuntimeError; end
|
11351
11507
|
|
11352
11508
|
# The root path for YARD source libraries
|
@@ -14621,42 +14777,42 @@ module YARD::Tags; end
|
|
14621
14777
|
# @see tag:!method
|
14622
14778
|
# @since 0.7.0
|
14623
14779
|
#
|
14624
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14780
|
+
# source://yard//lib/yard/tags/directives.rb#460
|
14625
14781
|
class YARD::Tags::AttributeDirective < ::YARD::Tags::MethodDirective
|
14626
14782
|
# @since 0.7.0
|
14627
14783
|
#
|
14628
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14784
|
+
# source://yard//lib/yard/tags/directives.rb#461
|
14629
14785
|
def after_parse; end
|
14630
14786
|
|
14631
14787
|
protected
|
14632
14788
|
|
14633
14789
|
# @since 0.7.0
|
14634
14790
|
#
|
14635
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14791
|
+
# source://yard//lib/yard/tags/directives.rb#469
|
14636
14792
|
def method_name; end
|
14637
14793
|
|
14638
14794
|
# @since 0.7.0
|
14639
14795
|
#
|
14640
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14796
|
+
# source://yard//lib/yard/tags/directives.rb#475
|
14641
14797
|
def method_signature; end
|
14642
14798
|
|
14643
14799
|
private
|
14644
14800
|
|
14645
14801
|
# @since 0.7.0
|
14646
14802
|
#
|
14647
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14803
|
+
# source://yard//lib/yard/tags/directives.rb#485
|
14648
14804
|
def create_attribute_data(object); end
|
14649
14805
|
|
14650
14806
|
# @return [Boolean]
|
14651
14807
|
# @since 0.7.0
|
14652
14808
|
#
|
14653
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14809
|
+
# source://yard//lib/yard/tags/directives.rb#515
|
14654
14810
|
def readable?; end
|
14655
14811
|
|
14656
14812
|
# @return [Boolean]
|
14657
14813
|
# @since 0.7.0
|
14658
14814
|
#
|
14659
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14815
|
+
# source://yard//lib/yard/tags/directives.rb#511
|
14660
14816
|
def writable?; end
|
14661
14817
|
end
|
14662
14818
|
|
@@ -14790,14 +14946,14 @@ end
|
|
14790
14946
|
# @see Library.define_directive
|
14791
14947
|
# @since 0.8.0
|
14792
14948
|
#
|
14793
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14949
|
+
# source://yard//lib/yard/tags/directives.rb#22
|
14794
14950
|
class YARD::Tags::Directive
|
14795
14951
|
# @param tag [Tag] the meta-data tag containing all input to the docstring
|
14796
14952
|
# @param parser [DocstringParser] the docstring parser object
|
14797
14953
|
# @return [Directive] a new instance of Directive
|
14798
14954
|
# @since 0.8.0
|
14799
14955
|
#
|
14800
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14956
|
+
# source://yard//lib/yard/tags/directives.rb#54
|
14801
14957
|
def initialize(tag, parser); end
|
14802
14958
|
|
14803
14959
|
# Called after parsing all directives and tags in the docstring. Used
|
@@ -14806,7 +14962,7 @@ class YARD::Tags::Directive
|
|
14806
14962
|
# @return [void]
|
14807
14963
|
# @since 0.8.0
|
14808
14964
|
#
|
14809
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14965
|
+
# source://yard//lib/yard/tags/directives.rb#73
|
14810
14966
|
def after_parse; end
|
14811
14967
|
|
14812
14968
|
# Called when processing the directive. Subclasses should implement
|
@@ -14818,7 +14974,7 @@ class YARD::Tags::Directive
|
|
14818
14974
|
# @return [void]
|
14819
14975
|
# @since 0.8.0
|
14820
14976
|
#
|
14821
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14977
|
+
# source://yard//lib/yard/tags/directives.rb#68
|
14822
14978
|
def call; end
|
14823
14979
|
|
14824
14980
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14830,7 +14986,7 @@ class YARD::Tags::Directive
|
|
14830
14986
|
# @return [nil] if no expansion should take place for this directive
|
14831
14987
|
# @since 0.8.0
|
14832
14988
|
#
|
14833
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14989
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14834
14990
|
def expanded_text; end
|
14835
14991
|
|
14836
14992
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14842,7 +14998,7 @@ class YARD::Tags::Directive
|
|
14842
14998
|
# @return [nil] if no expansion should take place for this directive
|
14843
14999
|
# @since 0.8.0
|
14844
15000
|
#
|
14845
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15001
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14846
15002
|
def expanded_text=(_arg0); end
|
14847
15003
|
|
14848
15004
|
# @return [Handlers::Base, nil] the handler object the docstring parser
|
@@ -14850,33 +15006,33 @@ class YARD::Tags::Directive
|
|
14850
15006
|
# through {Parser::SourceParser}.
|
14851
15007
|
# @since 0.8.0
|
14852
15008
|
#
|
14853
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15009
|
+
# source://yard//lib/yard/tags/directives.rb#48
|
14854
15010
|
def handler; end
|
14855
15011
|
|
14856
15012
|
# @return [CodeObjects::Base, nil] the object the parent docstring is
|
14857
15013
|
# attached to. May be nil.
|
14858
15014
|
# @since 0.8.0
|
14859
15015
|
#
|
14860
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15016
|
+
# source://yard//lib/yard/tags/directives.rb#42
|
14861
15017
|
def object; end
|
14862
15018
|
|
14863
15019
|
# @return [DocstringParser] the parser that is parsing all tag
|
14864
15020
|
# information out of the docstring
|
14865
15021
|
# @since 0.8.0
|
14866
15022
|
#
|
14867
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15023
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14868
15024
|
def parser=(_arg0); end
|
14869
15025
|
|
14870
15026
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14871
15027
|
# @since 0.8.0
|
14872
15028
|
#
|
14873
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15029
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14874
15030
|
def tag; end
|
14875
15031
|
|
14876
15032
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14877
15033
|
# @since 0.8.0
|
14878
15034
|
#
|
14879
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15035
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14880
15036
|
def tag=(_arg0); end
|
14881
15037
|
|
14882
15038
|
protected
|
@@ -14884,14 +15040,14 @@ class YARD::Tags::Directive
|
|
14884
15040
|
# @return [Boolean]
|
14885
15041
|
# @since 0.8.0
|
14886
15042
|
#
|
14887
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15043
|
+
# source://yard//lib/yard/tags/directives.rb#79
|
14888
15044
|
def inside_directive?; end
|
14889
15045
|
|
14890
15046
|
# @return [DocstringParser] the parser that is parsing all tag
|
14891
15047
|
# information out of the docstring
|
14892
15048
|
# @since 0.8.0
|
14893
15049
|
#
|
14894
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15050
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14895
15051
|
def parser; end
|
14896
15052
|
end
|
14897
15053
|
|
@@ -14915,11 +15071,11 @@ end
|
|
14915
15071
|
# @see tag:!group
|
14916
15072
|
# @since 0.6.0
|
14917
15073
|
#
|
14918
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15074
|
+
# source://yard//lib/yard/tags/directives.rb#104
|
14919
15075
|
class YARD::Tags::EndGroupDirective < ::YARD::Tags::Directive
|
14920
15076
|
# @since 0.6.0
|
14921
15077
|
#
|
14922
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15078
|
+
# source://yard//lib/yard/tags/directives.rb#105
|
14923
15079
|
def call; end
|
14924
15080
|
end
|
14925
15081
|
|
@@ -14940,11 +15096,11 @@ end
|
|
14940
15096
|
# @see tag:!endgroup
|
14941
15097
|
# @since 0.6.0
|
14942
15098
|
#
|
14943
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15099
|
+
# source://yard//lib/yard/tags/directives.rb#127
|
14944
15100
|
class YARD::Tags::GroupDirective < ::YARD::Tags::Directive
|
14945
15101
|
# @since 0.6.0
|
14946
15102
|
#
|
14947
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15103
|
+
# source://yard//lib/yard/tags/directives.rb#128
|
14948
15104
|
def call; end
|
14949
15105
|
end
|
14950
15106
|
|
@@ -15709,12 +15865,12 @@ end
|
|
15709
15865
|
# end
|
15710
15866
|
# @since 0.7.0
|
15711
15867
|
#
|
15712
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15868
|
+
# source://yard//lib/yard/tags/directives.rb#257
|
15713
15869
|
class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
15714
15870
|
# @raise [TagFormatError]
|
15715
15871
|
# @since 0.7.0
|
15716
15872
|
#
|
15717
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15873
|
+
# source://yard//lib/yard/tags/directives.rb#258
|
15718
15874
|
def call; end
|
15719
15875
|
|
15720
15876
|
private
|
@@ -15722,40 +15878,40 @@ class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
|
15722
15878
|
# @return [Boolean]
|
15723
15879
|
# @since 0.7.0
|
15724
15880
|
#
|
15725
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15881
|
+
# source://yard//lib/yard/tags/directives.rb#287
|
15726
15882
|
def anonymous?; end
|
15727
15883
|
|
15728
15884
|
# @return [Boolean]
|
15729
15885
|
# @since 0.7.0
|
15730
15886
|
#
|
15731
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15887
|
+
# source://yard//lib/yard/tags/directives.rb#276
|
15732
15888
|
def attach?; end
|
15733
15889
|
|
15734
15890
|
# @return [Boolean]
|
15735
15891
|
# @since 0.7.0
|
15736
15892
|
#
|
15737
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15893
|
+
# source://yard//lib/yard/tags/directives.rb#282
|
15738
15894
|
def class_method?; end
|
15739
15895
|
|
15740
15896
|
# @since 0.7.0
|
15741
15897
|
#
|
15742
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15898
|
+
# source://yard//lib/yard/tags/directives.rb#291
|
15743
15899
|
def expand(macro_data); end
|
15744
15900
|
|
15745
15901
|
# @since 0.7.0
|
15746
15902
|
#
|
15747
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15903
|
+
# source://yard//lib/yard/tags/directives.rb#307
|
15748
15904
|
def find_or_create; end
|
15749
15905
|
|
15750
15906
|
# @return [Boolean]
|
15751
15907
|
# @since 0.7.0
|
15752
15908
|
#
|
15753
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15909
|
+
# source://yard//lib/yard/tags/directives.rb#271
|
15754
15910
|
def new?; end
|
15755
15911
|
|
15756
15912
|
# @since 0.7.0
|
15757
15913
|
#
|
15758
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15914
|
+
# source://yard//lib/yard/tags/directives.rb#331
|
15759
15915
|
def warn; end
|
15760
15916
|
end
|
15761
15917
|
|
@@ -15788,49 +15944,49 @@ end
|
|
15788
15944
|
# @see tag:!attribute
|
15789
15945
|
# @since 0.7.0
|
15790
15946
|
#
|
15791
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15947
|
+
# source://yard//lib/yard/tags/directives.rb#367
|
15792
15948
|
class YARD::Tags::MethodDirective < ::YARD::Tags::Directive
|
15793
15949
|
# @since 0.7.0
|
15794
15950
|
#
|
15795
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15951
|
+
# source://yard//lib/yard/tags/directives.rb#372
|
15796
15952
|
def after_parse; end
|
15797
15953
|
|
15798
15954
|
# @since 0.7.0
|
15799
15955
|
#
|
15800
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15956
|
+
# source://yard//lib/yard/tags/directives.rb#370
|
15801
15957
|
def call; end
|
15802
15958
|
|
15803
15959
|
protected
|
15804
15960
|
|
15805
15961
|
# @since 0.7.0
|
15806
15962
|
#
|
15807
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15963
|
+
# source://yard//lib/yard/tags/directives.rb#412
|
15808
15964
|
def create_object; end
|
15809
15965
|
|
15810
15966
|
# @since 0.7.0
|
15811
15967
|
#
|
15812
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15968
|
+
# source://yard//lib/yard/tags/directives.rb#380
|
15813
15969
|
def method_name; end
|
15814
15970
|
|
15815
15971
|
# @since 0.7.0
|
15816
15972
|
#
|
15817
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15973
|
+
# source://yard//lib/yard/tags/directives.rb#389
|
15818
15974
|
def method_signature; end
|
15819
15975
|
|
15820
15976
|
# @since 0.7.0
|
15821
15977
|
#
|
15822
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15978
|
+
# source://yard//lib/yard/tags/directives.rb#393
|
15823
15979
|
def sanitized_tag_signature; end
|
15824
15980
|
|
15825
15981
|
# @since 0.7.0
|
15826
15982
|
#
|
15827
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15983
|
+
# source://yard//lib/yard/tags/directives.rb#402
|
15828
15984
|
def use_indented_text; end
|
15829
15985
|
end
|
15830
15986
|
|
15831
15987
|
# @since 0.7.0
|
15832
15988
|
#
|
15833
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15989
|
+
# source://yard//lib/yard/tags/directives.rb#368
|
15834
15990
|
YARD::Tags::MethodDirective::SCOPE_MATCH = T.let(T.unsafe(nil), Regexp)
|
15835
15991
|
|
15836
15992
|
# source://yard//lib/yard/tags/option_tag.rb#4
|
@@ -15942,11 +16098,11 @@ end
|
|
15942
16098
|
# # }
|
15943
16099
|
# @since 0.8.0
|
15944
16100
|
#
|
15945
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16101
|
+
# source://yard//lib/yard/tags/directives.rb#544
|
15946
16102
|
class YARD::Tags::ParseDirective < ::YARD::Tags::Directive
|
15947
16103
|
# @since 0.8.0
|
15948
16104
|
#
|
15949
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16105
|
+
# source://yard//lib/yard/tags/directives.rb#545
|
15950
16106
|
def call; end
|
15951
16107
|
end
|
15952
16108
|
|
@@ -16030,11 +16186,11 @@ end
|
|
16030
16186
|
# def method2; end
|
16031
16187
|
# @since 0.7.0
|
16032
16188
|
#
|
16033
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16189
|
+
# source://yard//lib/yard/tags/directives.rb#578
|
16034
16190
|
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
|
16035
16191
|
# @since 0.7.0
|
16036
16192
|
#
|
16037
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16193
|
+
# source://yard//lib/yard/tags/directives.rb#579
|
16038
16194
|
def call; end
|
16039
16195
|
end
|
16040
16196
|
|
@@ -16065,7 +16221,7 @@ class YARD::Tags::Tag
|
|
16065
16221
|
# @param name [String] optional key name which the tag refers to
|
16066
16222
|
# @return [Tag] a new instance of Tag
|
16067
16223
|
#
|
16068
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16224
|
+
# source://yard//lib/yard/tags/tag.rb#45
|
16069
16225
|
def initialize(tag_name, text, types = T.unsafe(nil), name = T.unsafe(nil)); end
|
16070
16226
|
|
16071
16227
|
# Provides a plain English summary of the type specification, or nil
|
@@ -16074,27 +16230,29 @@ class YARD::Tags::Tag
|
|
16074
16230
|
# @return [String] a plain English description of the associated types
|
16075
16231
|
# @return [nil] if no types are provided or not parsable
|
16076
16232
|
#
|
16077
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16233
|
+
# source://yard//lib/yard/tags/tag.rb#66
|
16078
16234
|
def explain_types; end
|
16079
16235
|
|
16080
16236
|
# @return [String] a name associated with the tag
|
16237
|
+
# @return [nil] if no tag name is supplied
|
16081
16238
|
#
|
16082
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16239
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16083
16240
|
def name; end
|
16084
16241
|
|
16085
16242
|
# @return [String] a name associated with the tag
|
16243
|
+
# @return [nil] if no tag name is supplied
|
16086
16244
|
#
|
16087
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16245
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16088
16246
|
def name=(_arg0); end
|
16089
16247
|
|
16090
16248
|
# @return [CodeObjects::Base] the associated object
|
16091
16249
|
#
|
16092
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16250
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16093
16251
|
def object; end
|
16094
16252
|
|
16095
16253
|
# @return [CodeObjects::Base] the associated object
|
16096
16254
|
#
|
16097
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16255
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16098
16256
|
def object=(_arg0); end
|
16099
16257
|
|
16100
16258
|
# @return [String] the name of the tag
|
@@ -16125,7 +16283,7 @@ class YARD::Tags::Tag
|
|
16125
16283
|
# @return [String] the first of the list of specified types
|
16126
16284
|
# @see #types
|
16127
16285
|
#
|
16128
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16286
|
+
# source://yard//lib/yard/tags/tag.rb#57
|
16129
16287
|
def type; end
|
16130
16288
|
|
16131
16289
|
# @return [Array<String>] a list of types associated with the tag
|
@@ -16316,11 +16474,11 @@ end
|
|
16316
16474
|
# def method2; end
|
16317
16475
|
# @since 0.7.0
|
16318
16476
|
#
|
16319
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16477
|
+
# source://yard//lib/yard/tags/directives.rb#610
|
16320
16478
|
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
|
16321
16479
|
# @since 0.7.0
|
16322
16480
|
#
|
16323
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16481
|
+
# source://yard//lib/yard/tags/directives.rb#611
|
16324
16482
|
def call; end
|
16325
16483
|
end
|
16326
16484
|
|
@@ -16336,7 +16494,7 @@ module YARD::Templates; end
|
|
16336
16494
|
# * To render a template, call {render}.
|
16337
16495
|
# * To register a template path in the lookup paths, call {register_template_path}.
|
16338
16496
|
#
|
16339
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16497
|
+
# source://yard//lib/yard/templates/engine.rb#11
|
16340
16498
|
module YARD::Templates::Engine
|
16341
16499
|
class << self
|
16342
16500
|
# Passes a set of objects to the +:fulldoc+ template for full documentation generation.
|
@@ -16348,7 +16506,7 @@ module YARD::Templates::Engine
|
|
16348
16506
|
# @param options [Hash] (see {render})
|
16349
16507
|
# @return [void]
|
16350
16508
|
#
|
16351
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16509
|
+
# source://yard//lib/yard/templates/engine.rb#100
|
16352
16510
|
def generate(objects, options = T.unsafe(nil)); end
|
16353
16511
|
|
16354
16512
|
# Registers a new template path in {template_paths}
|
@@ -16356,7 +16514,7 @@ module YARD::Templates::Engine
|
|
16356
16514
|
# @param path [String] a new template path
|
16357
16515
|
# @return [void]
|
16358
16516
|
#
|
16359
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16517
|
+
# source://yard//lib/yard/templates/engine.rb#20
|
16360
16518
|
def register_template_path(path); end
|
16361
16519
|
|
16362
16520
|
# Renders a template on a {CodeObjects::Base code object} using
|
@@ -16377,7 +16535,7 @@ module YARD::Templates::Engine
|
|
16377
16535
|
# @param options [Hash] the options hash
|
16378
16536
|
# @return [String] the rendered template
|
16379
16537
|
#
|
16380
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16538
|
+
# source://yard//lib/yard/templates/engine.rb#81
|
16381
16539
|
def render(options = T.unsafe(nil)); end
|
16382
16540
|
|
16383
16541
|
# Creates a template module representing the path. Searches on disk
|
@@ -16391,7 +16549,7 @@ module YARD::Templates::Engine
|
|
16391
16549
|
# {template_paths} on disk.
|
16392
16550
|
# @return [Template] the module representing the template
|
16393
16551
|
#
|
16394
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16552
|
+
# source://yard//lib/yard/templates/engine.rb#34
|
16395
16553
|
def template(*path); end
|
16396
16554
|
|
16397
16555
|
# Forces creation of a template at +path+ within a +full_path+.
|
@@ -16400,17 +16558,17 @@ module YARD::Templates::Engine
|
|
16400
16558
|
# @param full_paths [Array<String>] the full path on disk of the template
|
16401
16559
|
# @return [Template] the template module representing the +path+
|
16402
16560
|
#
|
16403
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16561
|
+
# source://yard//lib/yard/templates/engine.rb#52
|
16404
16562
|
def template!(path, full_paths = T.unsafe(nil)); end
|
16405
16563
|
|
16406
16564
|
# @return [Array<String>] the list of registered template paths
|
16407
16565
|
#
|
16408
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16566
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16409
16567
|
def template_paths; end
|
16410
16568
|
|
16411
16569
|
# @return [Array<String>] the list of registered template paths
|
16412
16570
|
#
|
16413
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16571
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16414
16572
|
def template_paths=(_arg0); end
|
16415
16573
|
|
16416
16574
|
# Serializes the results of a block with a +serializer+ object.
|
@@ -16421,7 +16579,7 @@ module YARD::Templates::Engine
|
|
16421
16579
|
# @yield a block whose result will be serialize
|
16422
16580
|
# @yieldreturn [String] the contents to serialize
|
16423
16581
|
#
|
16424
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16582
|
+
# source://yard//lib/yard/templates/engine.rb#114
|
16425
16583
|
def with_serializer(object, serializer); end
|
16426
16584
|
|
16427
16585
|
private
|
@@ -16436,7 +16594,7 @@ module YARD::Templates::Engine
|
|
16436
16594
|
# @return [Array<String>] a list of full paths that are existing
|
16437
16595
|
# candidates for a template module
|
16438
16596
|
#
|
16439
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16597
|
+
# source://yard//lib/yard/templates/engine.rb#160
|
16440
16598
|
def find_template_paths(from_template, path); end
|
16441
16599
|
|
16442
16600
|
# Sets default options on the options hash
|
@@ -16447,7 +16605,7 @@ module YARD::Templates::Engine
|
|
16447
16605
|
# @param options [Hash] the options hash
|
16448
16606
|
# @return [void]
|
16449
16607
|
#
|
16450
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16608
|
+
# source://yard//lib/yard/templates/engine.rb#140
|
16451
16609
|
def set_default_options(options = T.unsafe(nil)); end
|
16452
16610
|
|
16453
16611
|
# The name of the module that represents a +path+
|
@@ -16455,7 +16613,7 @@ module YARD::Templates::Engine
|
|
16455
16613
|
# @param path [String] the path to generate a module name for
|
16456
16614
|
# @return [String] the module name
|
16457
16615
|
#
|
16458
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16616
|
+
# source://yard//lib/yard/templates/engine.rb#175
|
16459
16617
|
def template_module_name(path); end
|
16460
16618
|
end
|
16461
16619
|
end
|
@@ -17866,7 +18024,7 @@ end
|
|
17866
18024
|
#
|
17867
18025
|
# @see CLI::YardocOptions
|
17868
18026
|
#
|
17869
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18027
|
+
# source://yard//lib/yard/templates/template_options.rb#9
|
17870
18028
|
class YARD::Templates::TemplateOptions < ::YARD::Options
|
17871
18029
|
# @return [OpenStruct] an open struct containing any global state across all
|
17872
18030
|
# generated objects in a template.
|
@@ -17909,7 +18067,7 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17909
18067
|
# @return [Boolean] whether a mixin matches the embed_mixins list
|
17910
18068
|
# @return [nil] if the mixin is not a module object
|
17911
18069
|
#
|
17912
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18070
|
+
# source://yard//lib/yard/templates/template_options.rb#77
|
17913
18071
|
def embed_mixins_match?(mixin); end
|
17914
18072
|
|
17915
18073
|
# @return [Symbol] the template output format
|
@@ -17956,12 +18114,12 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17956
18114
|
|
17957
18115
|
# @return [Boolean] whether the page is the "index"
|
17958
18116
|
#
|
17959
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18117
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17960
18118
|
def index; end
|
17961
18119
|
|
17962
18120
|
# @return [Boolean] whether the page is the "index"
|
17963
18121
|
#
|
17964
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18122
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17965
18123
|
def index=(_arg0); end
|
17966
18124
|
|
17967
18125
|
# @return [Symbol] the markup format to use when parsing docstrings
|
@@ -17976,51 +18134,51 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17976
18134
|
|
17977
18135
|
# @return [Class] the markup provider class for the markup format
|
17978
18136
|
#
|
17979
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18137
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
17980
18138
|
def markup_provider; end
|
17981
18139
|
|
17982
18140
|
# @return [Class] the markup provider class for the markup format
|
17983
18141
|
#
|
17984
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18142
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
17985
18143
|
def markup_provider=(_arg0); end
|
17986
18144
|
|
17987
18145
|
# @deprecated use {#highlight} instead.
|
17988
18146
|
# @return [Boolean] whether highlighting should be ignored
|
17989
18147
|
#
|
17990
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18148
|
+
# source://yard//lib/yard/templates/template_options.rb#56
|
17991
18149
|
def no_highlight; end
|
17992
18150
|
|
17993
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18151
|
+
# source://yard//lib/yard/templates/template_options.rb#57
|
17994
18152
|
def no_highlight=(value); end
|
17995
18153
|
|
17996
18154
|
# @return [CodeObjects::Base] the main object being generated in the template
|
17997
18155
|
#
|
17998
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18156
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
17999
18157
|
def object; end
|
18000
18158
|
|
18001
18159
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18002
18160
|
#
|
18003
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18161
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18004
18162
|
def object=(_arg0); end
|
18005
18163
|
|
18006
18164
|
# @return [CodeObjects::Base] the owner of the generated object
|
18007
18165
|
#
|
18008
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18166
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18009
18167
|
def owner; end
|
18010
18168
|
|
18011
18169
|
# @return [CodeObjects::Base] the owner of the generated object
|
18012
18170
|
#
|
18013
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18171
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18014
18172
|
def owner=(_arg0); end
|
18015
18173
|
|
18016
18174
|
# @return [String] the title of a given page
|
18017
18175
|
#
|
18018
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18176
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18019
18177
|
def page_title; end
|
18020
18178
|
|
18021
18179
|
# @return [String] the title of a given page
|
18022
18180
|
#
|
18023
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18181
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18024
18182
|
def page_title=(_arg0); end
|
18025
18183
|
|
18026
18184
|
# @return [Boolean] whether serialization should be performed
|
@@ -18036,13 +18194,13 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18036
18194
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18037
18195
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18038
18196
|
#
|
18039
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18197
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18040
18198
|
def serializer; end
|
18041
18199
|
|
18042
18200
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18043
18201
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18044
18202
|
#
|
18045
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18203
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18046
18204
|
def serializer=(_arg0); end
|
18047
18205
|
|
18048
18206
|
# @return [Symbol] the template name used to render output
|
@@ -18057,22 +18215,22 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18057
18215
|
|
18058
18216
|
# @return [Symbol] the template type used to generate output
|
18059
18217
|
#
|
18060
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18218
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18061
18219
|
def type; end
|
18062
18220
|
|
18063
18221
|
# @return [Symbol] the template type used to generate output
|
18064
18222
|
#
|
18065
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18223
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18066
18224
|
def type=(_arg0); end
|
18067
18225
|
|
18068
18226
|
# @return [Verifier] the verifier object
|
18069
18227
|
#
|
18070
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18228
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18071
18229
|
def verifier; end
|
18072
18230
|
|
18073
18231
|
# @return [Verifier] the verifier object
|
18074
18232
|
#
|
18075
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18233
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18076
18234
|
def verifier=(_arg0); end
|
18077
18235
|
end
|
18078
18236
|
|