mangrove 0.31.0 → 0.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -0
- data/README.md +131 -41
- data/lib/mangrove/result/ext.rb +18 -0
- data/lib/mangrove/result.rb +51 -0
- data/lib/mangrove/version.rb +1 -1
- data/lib/tapioca/dsl/compilers/mangrove_result_ext.rb +40 -0
- data/sorbet/config +1 -0
- data/sorbet/rbi/gems/benchmark@0.4.0.rbi +618 -0
- data/sorbet/rbi/gems/date@3.4.1.rbi +75 -0
- data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +2 -1
- data/sorbet/rbi/gems/{erubi@1.12.0.rbi → erubi@1.13.1.rbi} +26 -17
- data/sorbet/rbi/gems/{json@2.7.2.rbi → json@2.9.1.rbi} +516 -134
- data/sorbet/rbi/gems/logger@1.6.5.rbi +940 -0
- data/sorbet/rbi/gems/{parallel@1.24.0.rbi → parallel@1.26.3.rbi} +31 -21
- data/sorbet/rbi/gems/{parser@3.3.2.0.rbi → parser@3.3.7.0.rbi} +23 -1736
- data/sorbet/rbi/gems/{prism@0.29.0.rbi → prism@1.3.0.rbi} +13817 -10401
- data/sorbet/rbi/gems/{psych@5.1.2.rbi → psych@5.2.3.rbi} +289 -236
- data/sorbet/rbi/gems/{racc@1.8.0.rbi → racc@1.8.1.rbi} +0 -4
- data/sorbet/rbi/gems/rbi@0.2.3.rbi +4542 -0
- data/sorbet/rbi/gems/rbs@3.8.1.rbi +6882 -0
- data/sorbet/rbi/gems/{rdoc@6.7.0.rbi → rdoc@6.11.0.rbi} +1115 -1058
- data/sorbet/rbi/gems/{regexp_parser@2.9.2.rbi → regexp_parser@2.10.0.rbi} +193 -170
- data/sorbet/rbi/gems/{rspec-core@3.13.0.rbi → rspec-core@3.13.2.rbi} +146 -280
- data/sorbet/rbi/gems/{rspec-expectations@3.13.0.rbi → rspec-expectations@3.13.3.rbi} +323 -294
- data/sorbet/rbi/gems/{rspec-mocks@3.13.1.rbi → rspec-mocks@3.13.2.rbi} +46 -46
- data/sorbet/rbi/gems/{rspec-support@3.13.1.rbi → rspec-support@3.13.2.rbi} +22 -22
- data/sorbet/rbi/gems/ruboclean@0.7.1.rbi +473 -0
- data/sorbet/rbi/gems/{rubocop-ast@1.31.3.rbi → rubocop-ast@1.37.0.rbi} +1293 -745
- data/sorbet/rbi/gems/{rubocop-rspec@2.30.0.rbi → rubocop-rspec@3.4.0.rbi} +341 -1073
- data/sorbet/rbi/gems/{rubocop@1.64.1.rbi → rubocop@1.70.0.rbi} +5693 -3796
- data/sorbet/rbi/gems/{simplecov-html@0.12.3.rbi → simplecov-html@0.13.1.rbi} +77 -68
- data/sorbet/rbi/gems/{spoom@1.3.2.rbi → spoom@1.5.1.rbi} +2306 -1701
- data/sorbet/rbi/gems/{stringio@3.1.0.rbi → stringio@3.1.2.rbi} +1 -0
- data/sorbet/rbi/gems/{tapioca@0.14.3.rbi → tapioca@0.16.8.rbi} +411 -332
- data/sorbet/rbi/gems/{thor@1.3.1.rbi → thor@1.3.2.rbi} +57 -31
- data/sorbet/rbi/gems/unicode-display_width@3.1.4.rbi +132 -0
- data/sorbet/rbi/gems/unicode-emoji@4.0.4.rbi +251 -0
- data/sorbet/rbi/gems/{webrick@1.8.1.rbi → webrick@1.9.1.rbi} +92 -72
- 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} +393 -235
- metadata +41 -42
- data/sorbet/rbi/gems/rbi@0.1.13.rbi +0 -3078
- data/sorbet/rbi/gems/rexml@3.2.8.rbi +0 -4794
- data/sorbet/rbi/gems/ruboclean@0.6.0.rbi +0 -315
- data/sorbet/rbi/gems/rubocop-capybara@2.20.0.rbi +0 -1208
- data/sorbet/rbi/gems/rubocop-factory_bot@2.25.1.rbi +0 -928
- data/sorbet/rbi/gems/rubocop-rspec_rails@2.28.3.rbi +0 -911
- data/sorbet/rbi/gems/strscan@3.1.0.rbi +0 -9
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -65
- /data/sorbet/rbi/gems/{io-console@0.7.2.rbi → io-console@0.8.0.rbi} +0 -0
- /data/sorbet/rbi/gems/{reline@0.5.8.rbi → reline@0.6.0.rbi} +0 -0
- /data/sorbet/rbi/gems/{ruby-lsp@0.17.2.rbi → ruby-lsp@0.23.6.rbi} +0 -0
@@ -3287,11 +3287,11 @@ YARD::CodeObjects::METHODNAMEMATCH = T.let(T.unsafe(nil), Regexp)
|
|
3287
3287
|
# # Extra data added to docstring
|
3288
3288
|
# property :bar
|
3289
3289
|
#
|
3290
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3290
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#29
|
3291
3291
|
class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
3292
3292
|
# @return [Boolean] whether this macro is attached to a method
|
3293
3293
|
#
|
3294
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3294
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#148
|
3295
3295
|
def attached?; end
|
3296
3296
|
|
3297
3297
|
# Expands the macro using
|
@@ -3306,39 +3306,39 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3306
3306
|
# call, if there is a block.
|
3307
3307
|
# @see expand
|
3308
3308
|
#
|
3309
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3309
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#166
|
3310
3310
|
def expand(call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3311
3311
|
|
3312
3312
|
# @return [String] the macro data stored on the object
|
3313
3313
|
#
|
3314
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3314
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3315
3315
|
def macro_data; end
|
3316
3316
|
|
3317
3317
|
# @return [String] the macro data stored on the object
|
3318
3318
|
#
|
3319
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3319
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3320
3320
|
def macro_data=(_arg0); end
|
3321
3321
|
|
3322
3322
|
# @return [CodeObjects::Base] the method object that this macro is
|
3323
3323
|
# attached to.
|
3324
3324
|
#
|
3325
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3325
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3326
3326
|
def method_object; end
|
3327
3327
|
|
3328
3328
|
# @return [CodeObjects::Base] the method object that this macro is
|
3329
3329
|
# attached to.
|
3330
3330
|
#
|
3331
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3331
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3332
3332
|
def method_object=(_arg0); end
|
3333
3333
|
|
3334
3334
|
# Overrides {Base#path} so the macro path is ".macro.MACRONAME"
|
3335
3335
|
#
|
3336
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3336
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#151
|
3337
3337
|
def path; end
|
3338
3338
|
|
3339
3339
|
# Overrides the separator to be '.'
|
3340
3340
|
#
|
3341
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3341
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#154
|
3342
3342
|
def sep; end
|
3343
3343
|
|
3344
3344
|
class << self
|
@@ -3356,7 +3356,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3356
3356
|
# @return [String] the expanded macro data
|
3357
3357
|
# @see find_or_create
|
3358
3358
|
#
|
3359
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3359
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#119
|
3360
3360
|
def apply(docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil), _method_object = T.unsafe(nil)); end
|
3361
3361
|
|
3362
3362
|
# Applies a macro to a docstring, interpolating the macro's data on the
|
@@ -3372,7 +3372,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3372
3372
|
# interpolating the block data as a variable.
|
3373
3373
|
# @return [String] the expanded macro data
|
3374
3374
|
#
|
3375
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3375
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#135
|
3376
3376
|
def apply_macro(macro, docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3377
3377
|
|
3378
3378
|
# Creates a new macro and fills in the relevant properties.
|
@@ -3383,7 +3383,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3383
3383
|
# macro to. If supplied, {#attached?} will be true
|
3384
3384
|
# @return [MacroObject] the newly created object
|
3385
3385
|
#
|
3386
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3386
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#39
|
3387
3387
|
def create(macro_name, data, method_object = T.unsafe(nil)); end
|
3388
3388
|
|
3389
3389
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3403,7 +3403,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3403
3403
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3404
3404
|
# not new and no macro by the macro name is found.
|
3405
3405
|
#
|
3406
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3406
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3407
3407
|
def create_docstring(macro_name, data, method_object = T.unsafe(nil)); end
|
3408
3408
|
|
3409
3409
|
# Expands +macro_data+ using the interpolation parameters.
|
@@ -3416,7 +3416,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3416
3416
|
#
|
3417
3417
|
# @param macro_data [String] the macro data to expand (taken from {#macro_data})
|
3418
3418
|
#
|
3419
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3419
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#92
|
3420
3420
|
def expand(macro_data, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3421
3421
|
|
3422
3422
|
# Finds a macro using +macro_name+
|
@@ -3425,7 +3425,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3425
3425
|
# @return [MacroObject] if a macro is found
|
3426
3426
|
# @return [nil] if there is no registered macro by that name
|
3427
3427
|
#
|
3428
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3428
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#50
|
3429
3429
|
def find(macro_name); end
|
3430
3430
|
|
3431
3431
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3445,12 +3445,12 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3445
3445
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3446
3446
|
# not new and no macro by the macro name is found.
|
3447
3447
|
#
|
3448
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3448
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3449
3449
|
def find_or_create(macro_name, data, method_object = T.unsafe(nil)); end
|
3450
3450
|
end
|
3451
3451
|
end
|
3452
3452
|
|
3453
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3453
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#30
|
3454
3454
|
YARD::CodeObjects::MacroObject::MACRO_MATCH = T.let(T.unsafe(nil), Regexp)
|
3455
3455
|
|
3456
3456
|
# Represents a Ruby method in source
|
@@ -4785,7 +4785,7 @@ YARD::Docstring::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
|
4785
4785
|
# @see #parse_content
|
4786
4786
|
# @since 0.8.0
|
4787
4787
|
#
|
4788
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4788
|
+
# source://yard//lib/yard/docstring_parser.rb#29
|
4789
4789
|
class YARD::DocstringParser
|
4790
4790
|
# Creates a new parser to parse docstring data
|
4791
4791
|
#
|
@@ -4794,7 +4794,7 @@ class YARD::DocstringParser
|
|
4794
4794
|
# @return [DocstringParser] a new instance of DocstringParser
|
4795
4795
|
# @since 0.8.0
|
4796
4796
|
#
|
4797
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4797
|
+
# source://yard//lib/yard/docstring_parser.rb#80
|
4798
4798
|
def initialize(library = T.unsafe(nil)); end
|
4799
4799
|
|
4800
4800
|
# Creates a new directive using the registered {#library}
|
@@ -4802,14 +4802,14 @@ class YARD::DocstringParser
|
|
4802
4802
|
# @return [Tags::Directive] the directive object that is created
|
4803
4803
|
# @since 0.8.0
|
4804
4804
|
#
|
4805
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4805
|
+
# source://yard//lib/yard/docstring_parser.rb#231
|
4806
4806
|
def create_directive(tag_name, tag_buf); end
|
4807
4807
|
|
4808
4808
|
# Creates a {Tags::RefTag}
|
4809
4809
|
#
|
4810
4810
|
# @since 0.8.0
|
4811
4811
|
#
|
4812
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4812
|
+
# source://yard//lib/yard/docstring_parser.rb#225
|
4813
4813
|
def create_ref_tag(tag_name, name, object_name); end
|
4814
4814
|
|
4815
4815
|
# Creates a tag from the {Tags::DefaultFactory tag factory}.
|
@@ -4821,7 +4821,7 @@ class YARD::DocstringParser
|
|
4821
4821
|
# @return [Tags::Tag, Tags::RefTag] a tag
|
4822
4822
|
# @since 0.8.0
|
4823
4823
|
#
|
4824
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4824
|
+
# source://yard//lib/yard/docstring_parser.rb#208
|
4825
4825
|
def create_tag(tag_name, tag_buf = T.unsafe(nil)); end
|
4826
4826
|
|
4827
4827
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4829,7 +4829,7 @@ class YARD::DocstringParser
|
|
4829
4829
|
# Docstring object.
|
4830
4830
|
# @since 0.8.0
|
4831
4831
|
#
|
4832
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4832
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4833
4833
|
def directives; end
|
4834
4834
|
|
4835
4835
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4837,7 +4837,7 @@ class YARD::DocstringParser
|
|
4837
4837
|
# Docstring object.
|
4838
4838
|
# @since 0.8.0
|
4839
4839
|
#
|
4840
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4840
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4841
4841
|
def directives=(_arg0); end
|
4842
4842
|
|
4843
4843
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4845,7 +4845,7 @@ class YARD::DocstringParser
|
|
4845
4845
|
# initialized through
|
4846
4846
|
# @since 0.8.0
|
4847
4847
|
#
|
4848
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4848
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4849
4849
|
def handler; end
|
4850
4850
|
|
4851
4851
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4853,21 +4853,21 @@ class YARD::DocstringParser
|
|
4853
4853
|
# initialized through
|
4854
4854
|
# @since 0.8.0
|
4855
4855
|
#
|
4856
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4856
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4857
4857
|
def handler=(_arg0); end
|
4858
4858
|
|
4859
4859
|
# @return [Tags::Library] the tag library being used to
|
4860
4860
|
# identify registered tags in the docstring.
|
4861
4861
|
# @since 0.8.0
|
4862
4862
|
#
|
4863
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4863
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4864
4864
|
def library; end
|
4865
4865
|
|
4866
4866
|
# @return [Tags::Library] the tag library being used to
|
4867
4867
|
# identify registered tags in the docstring.
|
4868
4868
|
# @since 0.8.0
|
4869
4869
|
#
|
4870
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4870
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4871
4871
|
def library=(_arg0); end
|
4872
4872
|
|
4873
4873
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4875,7 +4875,7 @@ class YARD::DocstringParser
|
|
4875
4875
|
# not attached to any object.
|
4876
4876
|
# @since 0.8.0
|
4877
4877
|
#
|
4878
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4878
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4879
4879
|
def object; end
|
4880
4880
|
|
4881
4881
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4883,7 +4883,7 @@ class YARD::DocstringParser
|
|
4883
4883
|
# not attached to any object.
|
4884
4884
|
# @since 0.8.0
|
4885
4885
|
#
|
4886
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4886
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4887
4887
|
def object=(_arg0); end
|
4888
4888
|
|
4889
4889
|
# Parses all content and returns itself.
|
@@ -4900,7 +4900,7 @@ class YARD::DocstringParser
|
|
4900
4900
|
# @see #to_docstring
|
4901
4901
|
# @since 0.8.0
|
4902
4902
|
#
|
4903
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4903
|
+
# source://yard//lib/yard/docstring_parser.rb#112
|
4904
4904
|
def parse(content, object = T.unsafe(nil), handler = T.unsafe(nil)); end
|
4905
4905
|
|
4906
4906
|
# Parses a given block of text.
|
@@ -4910,7 +4910,7 @@ class YARD::DocstringParser
|
|
4910
4910
|
# @param content [String] the content to parse
|
4911
4911
|
# @since 0.8.0
|
4912
4912
|
#
|
4913
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4913
|
+
# source://yard//lib/yard/docstring_parser.rb#128
|
4914
4914
|
def parse_content(content); end
|
4915
4915
|
|
4916
4916
|
# Call post processing callbacks on parser.
|
@@ -4920,19 +4920,19 @@ class YARD::DocstringParser
|
|
4920
4920
|
# @return [void]
|
4921
4921
|
# @since 0.8.0
|
4922
4922
|
#
|
4923
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4923
|
+
# source://yard//lib/yard/docstring_parser.rb#195
|
4924
4924
|
def post_process; end
|
4925
4925
|
|
4926
4926
|
# @return [String] the complete input string to the parser.
|
4927
4927
|
# @since 0.8.0
|
4928
4928
|
#
|
4929
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4929
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4930
4930
|
def raw_text; end
|
4931
4931
|
|
4932
4932
|
# @return [String] the complete input string to the parser.
|
4933
4933
|
# @since 0.8.0
|
4934
4934
|
#
|
4935
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4935
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4936
4936
|
def raw_text=(_arg0); end
|
4937
4937
|
|
4938
4938
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4940,7 +4940,7 @@ class YARD::DocstringParser
|
|
4940
4940
|
# refer to any object.
|
4941
4941
|
# @since 0.8.0
|
4942
4942
|
#
|
4943
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4943
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4944
4944
|
def reference; end
|
4945
4945
|
|
4946
4946
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4948,7 +4948,7 @@ class YARD::DocstringParser
|
|
4948
4948
|
# refer to any object.
|
4949
4949
|
# @since 0.8.0
|
4950
4950
|
#
|
4951
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4951
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4952
4952
|
def reference=(_arg0); end
|
4953
4953
|
|
4954
4954
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4957,7 +4957,7 @@ class YARD::DocstringParser
|
|
4957
4957
|
# used in a docstring).
|
4958
4958
|
# @since 0.8.0
|
4959
4959
|
#
|
4960
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4960
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4961
4961
|
def state; end
|
4962
4962
|
|
4963
4963
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4966,7 +4966,7 @@ class YARD::DocstringParser
|
|
4966
4966
|
# used in a docstring).
|
4967
4967
|
# @since 0.8.0
|
4968
4968
|
#
|
4969
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4969
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4970
4970
|
def state=(_arg0); end
|
4971
4971
|
|
4972
4972
|
# Backward compatibility to detect old tags that should be specified
|
@@ -4975,42 +4975,42 @@ class YARD::DocstringParser
|
|
4975
4975
|
# @return [Boolean]
|
4976
4976
|
# @since 0.8.0
|
4977
4977
|
#
|
4978
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4978
|
+
# source://yard//lib/yard/docstring_parser.rb#251
|
4979
4979
|
def tag_is_directive?(tag_name); end
|
4980
4980
|
|
4981
4981
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4982
4982
|
# by the parser
|
4983
4983
|
# @since 0.8.0
|
4984
4984
|
#
|
4985
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4985
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4986
4986
|
def tags; end
|
4987
4987
|
|
4988
4988
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4989
4989
|
# by the parser
|
4990
4990
|
# @since 0.8.0
|
4991
4991
|
#
|
4992
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4992
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4993
4993
|
def tags=(_arg0); end
|
4994
4994
|
|
4995
4995
|
# @return [String] the parsed text portion of the docstring,
|
4996
4996
|
# with tags removed.
|
4997
4997
|
# @since 0.8.0
|
4998
4998
|
#
|
4999
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4999
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
5000
5000
|
def text; end
|
5001
5001
|
|
5002
5002
|
# @return [String] the parsed text portion of the docstring,
|
5003
5003
|
# with tags removed.
|
5004
5004
|
# @since 0.8.0
|
5005
5005
|
#
|
5006
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5006
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
5007
5007
|
def text=(_arg0); end
|
5008
5008
|
|
5009
5009
|
# @return [Docstring] translates parsed text into
|
5010
5010
|
# a Docstring object.
|
5011
5011
|
# @since 0.8.0
|
5012
5012
|
#
|
5013
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5013
|
+
# source://yard//lib/yard/docstring_parser.rb#94
|
5014
5014
|
def to_docstring; end
|
5015
5015
|
|
5016
5016
|
private
|
@@ -5019,7 +5019,7 @@ class YARD::DocstringParser
|
|
5019
5019
|
#
|
5020
5020
|
# @since 0.8.0
|
5021
5021
|
#
|
5022
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5022
|
+
# source://yard//lib/yard/docstring_parser.rb#323
|
5023
5023
|
def call_after_parse_callbacks; end
|
5024
5024
|
|
5025
5025
|
# Calls the {Tags::Directive#after_parse} callback on all the
|
@@ -5027,17 +5027,17 @@ class YARD::DocstringParser
|
|
5027
5027
|
#
|
5028
5028
|
# @since 0.8.0
|
5029
5029
|
#
|
5030
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5030
|
+
# source://yard//lib/yard/docstring_parser.rb#318
|
5031
5031
|
def call_directives_after_parse; end
|
5032
5032
|
|
5033
5033
|
# @since 0.8.0
|
5034
5034
|
#
|
5035
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5035
|
+
# source://yard//lib/yard/docstring_parser.rb#304
|
5036
5036
|
def detect_reference(content); end
|
5037
5037
|
|
5038
5038
|
# @since 0.8.0
|
5039
5039
|
#
|
5040
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5040
|
+
# source://yard//lib/yard/docstring_parser.rb#300
|
5041
5041
|
def namespace; end
|
5042
5042
|
|
5043
5043
|
class << self
|
@@ -5052,13 +5052,13 @@ class YARD::DocstringParser
|
|
5052
5052
|
# with all directives and tags created.
|
5053
5053
|
# @yieldreturn [void]
|
5054
5054
|
#
|
5055
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5055
|
+
# source://yard//lib/yard/docstring_parser.rb#265
|
5056
5056
|
def after_parse(&block); end
|
5057
5057
|
|
5058
5058
|
# @return [Array<Proc>] the {after_parse} callback proc objects
|
5059
5059
|
# @since 0.8.0
|
5060
5060
|
#
|
5061
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5061
|
+
# source://yard//lib/yard/docstring_parser.rb#270
|
5062
5062
|
def after_parse_callbacks; end
|
5063
5063
|
end
|
5064
5064
|
end
|
@@ -5067,7 +5067,7 @@ end
|
|
5067
5067
|
#
|
5068
5068
|
# @since 0.8.0
|
5069
5069
|
#
|
5070
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5070
|
+
# source://yard//lib/yard/docstring_parser.rb#72
|
5071
5071
|
YARD::DocstringParser::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
5072
5072
|
|
5073
5073
|
# source://yard//lib/yard/gem_index.rb#6
|
@@ -5976,14 +5976,14 @@ end
|
|
5976
5976
|
#
|
5977
5977
|
# @see Handlers::Base
|
5978
5978
|
#
|
5979
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5979
|
+
# source://yard//lib/yard/handlers/processor.rb#19
|
5980
5980
|
class YARD::Handlers::Processor
|
5981
5981
|
# Creates a new Processor for a +file+.
|
5982
5982
|
#
|
5983
5983
|
# @param parser [Parser::SourceParser] the parser used to initialize the processor
|
5984
5984
|
# @return [Processor] a new instance of Processor
|
5985
5985
|
#
|
5986
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5986
|
+
# source://yard//lib/yard/handlers/processor.rb#91
|
5987
5987
|
def initialize(parser); end
|
5988
5988
|
|
5989
5989
|
# Share state across different handlers inside of a file.
|
@@ -5996,7 +5996,7 @@ class YARD::Handlers::Processor
|
|
5996
5996
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5997
5997
|
# @see #globals
|
5998
5998
|
#
|
5999
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5999
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
6000
6000
|
def extra_state; end
|
6001
6001
|
|
6002
6002
|
# Share state across different handlers inside of a file.
|
@@ -6009,17 +6009,17 @@ class YARD::Handlers::Processor
|
|
6009
6009
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
6010
6010
|
# @see #globals
|
6011
6011
|
#
|
6012
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6012
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
6013
6013
|
def extra_state=(_arg0); end
|
6014
6014
|
|
6015
6015
|
# @return [String] the filename
|
6016
6016
|
#
|
6017
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6017
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
6018
6018
|
def file; end
|
6019
6019
|
|
6020
6020
|
# @return [String] the filename
|
6021
6021
|
#
|
6022
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6022
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
6023
6023
|
def file=(_arg0); end
|
6024
6024
|
|
6025
6025
|
# Searches for all handlers in {Base.subclasses} that match the +statement+
|
@@ -6027,7 +6027,7 @@ class YARD::Handlers::Processor
|
|
6027
6027
|
# @param statement the statement object to match.
|
6028
6028
|
# @return [Array<Base>] a list of handlers to process the statement with.
|
6029
6029
|
#
|
6030
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6030
|
+
# source://yard//lib/yard/handlers/processor.rb#150
|
6031
6031
|
def find_handlers(statement); end
|
6032
6032
|
|
6033
6033
|
# Handlers can share state for the entire post processing stage through
|
@@ -6047,7 +6047,7 @@ class YARD::Handlers::Processor
|
|
6047
6047
|
# @return [OpenStruct] global shared state for post-processing stage
|
6048
6048
|
# @see #extra_state
|
6049
6049
|
#
|
6050
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6050
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6051
6051
|
def globals; end
|
6052
6052
|
|
6053
6053
|
# Handlers can share state for the entire post processing stage through
|
@@ -6067,17 +6067,17 @@ class YARD::Handlers::Processor
|
|
6067
6067
|
# @return [OpenStruct] global shared state for post-processing stage
|
6068
6068
|
# @see #extra_state
|
6069
6069
|
#
|
6070
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6070
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6071
6071
|
def globals=(_arg0); end
|
6072
6072
|
|
6073
6073
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6074
6074
|
#
|
6075
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6075
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6076
6076
|
def namespace; end
|
6077
6077
|
|
6078
6078
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6079
6079
|
#
|
6080
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6080
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6081
6081
|
def namespace=(_arg0); end
|
6082
6082
|
|
6083
6083
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6085,7 +6085,7 @@ class YARD::Handlers::Processor
|
|
6085
6085
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6086
6086
|
# is set as the owner, in case any extra method information is processed.
|
6087
6087
|
#
|
6088
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6088
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6089
6089
|
def owner; end
|
6090
6090
|
|
6091
6091
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6093,7 +6093,7 @@ class YARD::Handlers::Processor
|
|
6093
6093
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6094
6094
|
# is set as the owner, in case any extra method information is processed.
|
6095
6095
|
#
|
6096
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6096
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6097
6097
|
def owner=(_arg0); end
|
6098
6098
|
|
6099
6099
|
# Continue parsing the remainder of the files in the +globals.ordered_parser+
|
@@ -6103,17 +6103,17 @@ class YARD::Handlers::Processor
|
|
6103
6103
|
# @return [void]
|
6104
6104
|
# @see Parser::OrderedParser
|
6105
6105
|
#
|
6106
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6106
|
+
# source://yard//lib/yard/handlers/processor.rb#139
|
6107
6107
|
def parse_remaining_files; end
|
6108
6108
|
|
6109
6109
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6110
6110
|
#
|
6111
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6111
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6112
6112
|
def parser_type; end
|
6113
6113
|
|
6114
6114
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6115
6115
|
#
|
6116
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6116
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6117
6117
|
def parser_type=(_arg0); end
|
6118
6118
|
|
6119
6119
|
# Processes a list of statements by finding handlers to process each
|
@@ -6122,27 +6122,27 @@ class YARD::Handlers::Processor
|
|
6122
6122
|
# @param statements [Array] a list of statements
|
6123
6123
|
# @return [void]
|
6124
6124
|
#
|
6125
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6125
|
+
# source://yard//lib/yard/handlers/processor.rb#109
|
6126
6126
|
def process(statements); end
|
6127
6127
|
|
6128
6128
|
# @return [Symbol] the current scope (class, instance)
|
6129
6129
|
#
|
6130
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6130
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6131
6131
|
def scope; end
|
6132
6132
|
|
6133
6133
|
# @return [Symbol] the current scope (class, instance)
|
6134
6134
|
#
|
6135
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6135
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6136
6136
|
def scope=(_arg0); end
|
6137
6137
|
|
6138
6138
|
# @return [Symbol] the current visibility (public, private, protected)
|
6139
6139
|
#
|
6140
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6140
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6141
6141
|
def visibility; end
|
6142
6142
|
|
6143
6143
|
# @return [Symbol] the current visibility (public, private, protected)
|
6144
6144
|
#
|
6145
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6145
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6146
6146
|
def visibility=(_arg0); end
|
6147
6147
|
|
6148
6148
|
private
|
@@ -6151,7 +6151,7 @@ class YARD::Handlers::Processor
|
|
6151
6151
|
#
|
6152
6152
|
# @return [Base] the base class
|
6153
6153
|
#
|
6154
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6154
|
+
# source://yard//lib/yard/handlers/processor.rb#171
|
6155
6155
|
def handler_base_class; end
|
6156
6156
|
|
6157
6157
|
# The module holding the handlers to be loaded
|
@@ -6159,12 +6159,12 @@ class YARD::Handlers::Processor
|
|
6159
6159
|
# @return [Module] the module containing the handlers depending on
|
6160
6160
|
# {#parser_type}.
|
6161
6161
|
#
|
6162
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6162
|
+
# source://yard//lib/yard/handlers/processor.rb#179
|
6163
6163
|
def handler_base_namespace; end
|
6164
6164
|
|
6165
6165
|
# @return [Boolean]
|
6166
6166
|
#
|
6167
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6167
|
+
# source://yard//lib/yard/handlers/processor.rb#160
|
6168
6168
|
def handles?(handler, statement); end
|
6169
6169
|
|
6170
6170
|
# Loads handlers from {#handler_base_namespace}. This ensures that
|
@@ -6173,7 +6173,7 @@ class YARD::Handlers::Processor
|
|
6173
6173
|
#
|
6174
6174
|
# @return [void]
|
6175
6175
|
#
|
6176
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6176
|
+
# source://yard//lib/yard/handlers/processor.rb#187
|
6177
6177
|
def load_handlers; end
|
6178
6178
|
|
6179
6179
|
class << self
|
@@ -6181,14 +6181,14 @@ class YARD::Handlers::Processor
|
|
6181
6181
|
# @return [Hash] a list of registered parser type extensions
|
6182
6182
|
# @since 0.6.0
|
6183
6183
|
#
|
6184
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6184
|
+
# source://yard//lib/yard/handlers/processor.rb#32
|
6185
6185
|
def namespace_for_handler; end
|
6186
6186
|
|
6187
6187
|
# Registers a new namespace for handlers of the given type.
|
6188
6188
|
#
|
6189
6189
|
# @since 0.6.0
|
6190
6190
|
#
|
6191
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6191
|
+
# source://yard//lib/yard/handlers/processor.rb#23
|
6192
6192
|
def register_handler_namespace(type, ns); end
|
6193
6193
|
end
|
6194
6194
|
end
|
@@ -7021,6 +7021,11 @@ end
|
|
7021
7021
|
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#3
|
7022
7022
|
class YARD::Handlers::Ruby::VisibilityHandler < ::YARD::Handlers::Ruby::Base
|
7023
7023
|
include ::YARD::Handlers::Ruby::DecoratorHandlerMethods
|
7024
|
+
|
7025
|
+
# @return [Boolean]
|
7026
|
+
#
|
7027
|
+
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#31
|
7028
|
+
def is_attribute_method?(node); end
|
7024
7029
|
end
|
7025
7030
|
|
7026
7031
|
# Handles 'yield' calls
|
@@ -7483,13 +7488,16 @@ end
|
|
7483
7488
|
# Handles console logging for info, warnings and errors.
|
7484
7489
|
# Uses the stdlib Logger class in Ruby for all the backend logic.
|
7485
7490
|
#
|
7486
|
-
# source://yard//lib/yard/logging.rb#
|
7487
|
-
class YARD::Logger
|
7491
|
+
# source://yard//lib/yard/logging.rb#8
|
7492
|
+
class YARD::Logger
|
7493
|
+
include ::YARD::Logger::Severity
|
7494
|
+
|
7488
7495
|
# Creates a new logger
|
7489
7496
|
#
|
7497
|
+
# @private
|
7490
7498
|
# @return [Logger] a new instance of Logger
|
7491
7499
|
#
|
7492
|
-
# source://yard//lib/yard/logging.rb#
|
7500
|
+
# source://yard//lib/yard/logging.rb#82
|
7493
7501
|
def initialize(pipe, *args); end
|
7494
7502
|
|
7495
7503
|
# Displays an unformatted line to the logger output stream.
|
@@ -7498,7 +7506,7 @@ class YARD::Logger < ::Logger
|
|
7498
7506
|
# @return [void]
|
7499
7507
|
# @since 0.8.2
|
7500
7508
|
#
|
7501
|
-
# source://yard//lib/yard/logging.rb#
|
7509
|
+
# source://yard//lib/yard/logging.rb#205
|
7502
7510
|
def <<(msg = T.unsafe(nil)); end
|
7503
7511
|
|
7504
7512
|
# Prints the backtrace +exc+ to the logger as error data.
|
@@ -7507,7 +7515,7 @@ class YARD::Logger < ::Logger
|
|
7507
7515
|
# @param level_meth [Symbol] the level to log backtrace at
|
7508
7516
|
# @return [void]
|
7509
7517
|
#
|
7510
|
-
# source://yard//lib/yard/logging.rb#
|
7518
|
+
# source://yard//lib/yard/logging.rb#216
|
7511
7519
|
def backtrace(exc, level_meth = T.unsafe(nil)); end
|
7512
7520
|
|
7513
7521
|
# Captures the duration of a block of code for benchmark analysis. Also
|
@@ -7520,7 +7528,7 @@ class YARD::Logger < ::Logger
|
|
7520
7528
|
# @todo Implement capture storage for reporting of benchmarks
|
7521
7529
|
# @yield a block of arbitrary code to benchmark
|
7522
7530
|
#
|
7523
|
-
# source://yard//lib/yard/logging.rb#
|
7531
|
+
# source://yard//lib/yard/logging.rb#234
|
7524
7532
|
def capture(msg, nontty_log = T.unsafe(nil)); end
|
7525
7533
|
|
7526
7534
|
# Clears the progress indicator in the TTY display.
|
@@ -7528,14 +7536,18 @@ class YARD::Logger < ::Logger
|
|
7528
7536
|
# @return [void]
|
7529
7537
|
# @since 0.8.2
|
7530
7538
|
#
|
7531
|
-
# source://yard//lib/yard/logging.rb#
|
7539
|
+
# source://yard//lib/yard/logging.rb#186
|
7532
7540
|
def clear_progress; end
|
7533
7541
|
|
7534
|
-
# Changes the debug level to DEBUG if $DEBUG is set
|
7535
|
-
#
|
7542
|
+
# Changes the debug level to DEBUG if $DEBUG is set and writes a debugging message.
|
7543
|
+
# Logs a message with the debug severity level.
|
7536
7544
|
#
|
7537
|
-
#
|
7538
|
-
|
7545
|
+
# @param message [String] the message to log
|
7546
|
+
# @return [void]
|
7547
|
+
# @see #log
|
7548
|
+
#
|
7549
|
+
# source://yard//lib/yard/logging.rb#103
|
7550
|
+
def debug(message); end
|
7539
7551
|
|
7540
7552
|
# Sets the logger level for the duration of the block
|
7541
7553
|
#
|
@@ -7547,17 +7559,65 @@ class YARD::Logger < ::Logger
|
|
7547
7559
|
# values can be found in Ruby's Logger class.
|
7548
7560
|
# @yield the block with the logger temporarily set to +new_level+
|
7549
7561
|
#
|
7550
|
-
# source://yard//lib/yard/logging.rb#
|
7562
|
+
# source://yard//lib/yard/logging.rb#142
|
7551
7563
|
def enter_level(new_level = T.unsafe(nil)); end
|
7552
7564
|
|
7565
|
+
# Logs a message with the error severity level.
|
7566
|
+
#
|
7567
|
+
# @param message [String] the message to log
|
7568
|
+
# @return [void]
|
7569
|
+
# @see #log
|
7570
|
+
#
|
7571
|
+
# source://yard//lib/yard/logging.rb#103
|
7572
|
+
def error(message); end
|
7573
|
+
|
7574
|
+
# Logs a message with the fatal severity level.
|
7575
|
+
#
|
7576
|
+
# @param message [String] the message to log
|
7577
|
+
# @return [void]
|
7578
|
+
# @see #log
|
7579
|
+
#
|
7580
|
+
# source://yard//lib/yard/logging.rb#103
|
7581
|
+
def fatal(message); end
|
7582
|
+
|
7583
|
+
# Logs a message with the info severity level.
|
7584
|
+
#
|
7585
|
+
# @param message [String] the message to log
|
7586
|
+
# @return [void]
|
7587
|
+
# @see #log
|
7588
|
+
#
|
7589
|
+
# source://yard//lib/yard/logging.rb#103
|
7590
|
+
def info(message); end
|
7591
|
+
|
7553
7592
|
# @return [IO] the IO object being logged to
|
7554
7593
|
# @since 0.8.2
|
7555
7594
|
#
|
7556
|
-
# source://yard//lib/yard/logging.rb#
|
7595
|
+
# source://yard//lib/yard/logging.rb#49
|
7557
7596
|
def io; end
|
7558
7597
|
|
7559
|
-
#
|
7560
|
-
|
7598
|
+
# @return [IO] the IO object being logged to
|
7599
|
+
# @since 0.8.2
|
7600
|
+
#
|
7601
|
+
# source://yard//lib/yard/logging.rb#49
|
7602
|
+
def io=(_arg0); end
|
7603
|
+
|
7604
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7605
|
+
#
|
7606
|
+
# source://yard//lib/yard/logging.rb#57
|
7607
|
+
def level; end
|
7608
|
+
|
7609
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7610
|
+
#
|
7611
|
+
# source://yard//lib/yard/logging.rb#57
|
7612
|
+
def level=(_arg0); end
|
7613
|
+
|
7614
|
+
# Logs a message with a given severity
|
7615
|
+
#
|
7616
|
+
# @param severity [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the severity level
|
7617
|
+
# @param message [String] the message to log
|
7618
|
+
#
|
7619
|
+
# source://yard//lib/yard/logging.rb#122
|
7620
|
+
def log(severity, message); end
|
7561
7621
|
|
7562
7622
|
# Displays an unformatted line to the logger output stream.
|
7563
7623
|
#
|
@@ -7565,7 +7625,7 @@ 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#205
|
7569
7629
|
def print(msg = T.unsafe(nil)); end
|
7570
7630
|
|
7571
7631
|
# Displays a progress indicator for a given message. This progress report
|
@@ -7578,7 +7638,7 @@ class YARD::Logger < ::Logger
|
|
7578
7638
|
# @return [void]
|
7579
7639
|
# @since 0.8.2
|
7580
7640
|
#
|
7581
|
-
# source://yard//lib/yard/logging.rb#
|
7641
|
+
# source://yard//lib/yard/logging.rb#161
|
7582
7642
|
def progress(msg, nontty_log = T.unsafe(nil)); end
|
7583
7643
|
|
7584
7644
|
# Displays an unformatted line to the logger output stream, adding
|
@@ -7588,86 +7648,91 @@ class YARD::Logger < ::Logger
|
|
7588
7648
|
# @return [void]
|
7589
7649
|
# @since 0.8.2
|
7590
7650
|
#
|
7591
|
-
# source://yard//lib/yard/logging.rb#
|
7651
|
+
# source://yard//lib/yard/logging.rb#197
|
7592
7652
|
def puts(msg = T.unsafe(nil)); end
|
7593
7653
|
|
7594
7654
|
# @return [Boolean] whether backtraces should be shown (by default
|
7595
7655
|
# this is on).
|
7596
7656
|
#
|
7597
|
-
# source://yard//lib/yard/logging.rb#
|
7657
|
+
# source://yard//lib/yard/logging.rb#53
|
7598
7658
|
def show_backtraces; end
|
7599
7659
|
|
7600
7660
|
# Sets the attribute show_backtraces
|
7601
7661
|
#
|
7602
7662
|
# @param value the value to set the attribute show_backtraces to.
|
7603
7663
|
#
|
7604
|
-
# source://yard//lib/yard/logging.rb#
|
7664
|
+
# source://yard//lib/yard/logging.rb#54
|
7605
7665
|
def show_backtraces=(_arg0); end
|
7606
7666
|
|
7607
7667
|
# @return [Boolean] whether progress indicators should be shown when
|
7608
7668
|
# logging CLIs (by default this is off).
|
7609
7669
|
#
|
7610
|
-
# source://yard//lib/yard/logging.rb#
|
7670
|
+
# source://yard//lib/yard/logging.rb#64
|
7611
7671
|
def show_progress; end
|
7612
7672
|
|
7613
7673
|
# Sets the attribute show_progress
|
7614
7674
|
#
|
7615
7675
|
# @param value the value to set the attribute show_progress to.
|
7616
7676
|
#
|
7617
|
-
# source://yard//lib/yard/logging.rb#
|
7677
|
+
# source://yard//lib/yard/logging.rb#70
|
7618
7678
|
def show_progress=(_arg0); end
|
7619
7679
|
|
7680
|
+
# Logs a message with the unknown severity level.
|
7681
|
+
#
|
7682
|
+
# @param message [String] the message to log
|
7683
|
+
# @return [void]
|
7684
|
+
# @see #log
|
7685
|
+
#
|
7686
|
+
# source://yard//lib/yard/logging.rb#103
|
7687
|
+
def unknown(message); end
|
7688
|
+
|
7620
7689
|
# Remembers when a warning occurs and writes a warning message.
|
7690
|
+
# Logs a message with the warn severity level.
|
7621
7691
|
#
|
7622
|
-
#
|
7623
|
-
|
7692
|
+
# @param message [String] the message to log
|
7693
|
+
# @return [void]
|
7694
|
+
# @see #log
|
7695
|
+
#
|
7696
|
+
# source://yard//lib/yard/logging.rb#103
|
7697
|
+
def warn(message); end
|
7624
7698
|
|
7625
7699
|
# Warns that the Ruby environment does not support continuations. Applies
|
7626
7700
|
# to JRuby, Rubinius and MacRuby. This warning will only display once
|
7627
7701
|
# per Ruby process.
|
7628
7702
|
#
|
7629
7703
|
# @deprecated Continuations are no longer needed by YARD 0.8.0+.
|
7704
|
+
# @private
|
7630
7705
|
# @return [void]
|
7631
7706
|
#
|
7632
|
-
# source://yard//lib/yard/logging.rb#
|
7707
|
+
# source://yard//lib/yard/logging.rb#250
|
7633
7708
|
def warn_no_continuations; end
|
7634
7709
|
|
7635
|
-
#
|
7710
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7636
7711
|
#
|
7637
|
-
# source://yard//lib/yard/logging.rb#
|
7712
|
+
# source://yard//lib/yard/logging.rb#60
|
7638
7713
|
def warned; end
|
7639
7714
|
|
7640
|
-
#
|
7715
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7641
7716
|
#
|
7642
|
-
#
|
7643
|
-
#
|
7644
|
-
# source://yard//lib/yard/logging.rb#69
|
7717
|
+
# source://yard//lib/yard/logging.rb#60
|
7645
7718
|
def warned=(_arg0); end
|
7646
7719
|
|
7647
7720
|
private
|
7648
7721
|
|
7649
|
-
#
|
7650
|
-
#
|
7651
|
-
# source://yard//lib/yard/logging.rb#190
|
7652
|
-
def add(*args); end
|
7653
|
-
|
7654
|
-
# source://yard//lib/yard/logging.rb#195
|
7722
|
+
# source://yard//lib/yard/logging.rb#255
|
7655
7723
|
def clear_line; end
|
7656
7724
|
|
7657
|
-
# Log format (from Logger implementation). Used by Logger internally
|
7658
|
-
#
|
7659
|
-
# source://yard//lib/yard/logging.rb#201
|
7660
|
-
def format_log(sev, _time, _prog, msg); end
|
7661
|
-
|
7662
|
-
# source://logger/1.6.0/logger.rb#684
|
7663
|
-
def print_no_newline(msg); end
|
7664
|
-
|
7665
7725
|
class << self
|
7726
|
+
# @private
|
7727
|
+
#
|
7728
|
+
# source://yard//lib/yard/logging.rb#101
|
7729
|
+
def create_log_method(name); end
|
7730
|
+
|
7666
7731
|
# The logger instance
|
7667
7732
|
#
|
7668
7733
|
# @return [Logger] the logger instance
|
7669
7734
|
#
|
7670
|
-
# source://yard//lib/yard/logging.rb#
|
7735
|
+
# source://yard//lib/yard/logging.rb#76
|
7671
7736
|
def instance(pipe = T.unsafe(nil)); end
|
7672
7737
|
end
|
7673
7738
|
end
|
@@ -7677,9 +7742,97 @@ end
|
|
7677
7742
|
#
|
7678
7743
|
# @since 0.8.2
|
7679
7744
|
#
|
7680
|
-
# source://yard//lib/yard/logging.rb#
|
7745
|
+
# source://yard//lib/yard/logging.rb#45
|
7681
7746
|
YARD::Logger::PROGRESS_INDICATORS = T.let(T.unsafe(nil), Array)
|
7682
7747
|
|
7748
|
+
# Log severity levels
|
7749
|
+
#
|
7750
|
+
# source://yard//lib/yard/logging.rb#10
|
7751
|
+
module YARD::Logger::Severity; end
|
7752
|
+
|
7753
|
+
# Debugging log level
|
7754
|
+
#
|
7755
|
+
# source://yard//lib/yard/logging.rb#12
|
7756
|
+
YARD::Logger::Severity::DEBUG = T.let(T.unsafe(nil), Integer)
|
7757
|
+
|
7758
|
+
# Error log level
|
7759
|
+
#
|
7760
|
+
# source://yard//lib/yard/logging.rb#21
|
7761
|
+
YARD::Logger::Severity::ERROR = T.let(T.unsafe(nil), Integer)
|
7762
|
+
|
7763
|
+
# Fatal log level
|
7764
|
+
#
|
7765
|
+
# source://yard//lib/yard/logging.rb#24
|
7766
|
+
YARD::Logger::Severity::FATAL = T.let(T.unsafe(nil), Integer)
|
7767
|
+
|
7768
|
+
# Information log level
|
7769
|
+
#
|
7770
|
+
# source://yard//lib/yard/logging.rb#15
|
7771
|
+
YARD::Logger::Severity::INFO = T.let(T.unsafe(nil), Integer)
|
7772
|
+
|
7773
|
+
# @private
|
7774
|
+
#
|
7775
|
+
# source://yard//lib/yard/logging.rb#30
|
7776
|
+
YARD::Logger::Severity::SEVERITIES = T.let(T.unsafe(nil), Hash)
|
7777
|
+
|
7778
|
+
# Unknown log level
|
7779
|
+
#
|
7780
|
+
# source://yard//lib/yard/logging.rb#27
|
7781
|
+
YARD::Logger::Severity::UNKNOWN = T.let(T.unsafe(nil), Integer)
|
7782
|
+
|
7783
|
+
# Warning log level
|
7784
|
+
#
|
7785
|
+
# source://yard//lib/yard/logging.rb#18
|
7786
|
+
YARD::Logger::Severity::WARN = T.let(T.unsafe(nil), Integer)
|
7787
|
+
|
7788
|
+
# An OpenStruct compatible struct class that allows for basic access of attributes
|
7789
|
+
# via +struct.attr_name+ and +struct.attr_name = value+.
|
7790
|
+
#
|
7791
|
+
# source://yard//lib/yard/open_struct.rb#4
|
7792
|
+
class YARD::OpenStruct
|
7793
|
+
# @return [OpenStruct] a new instance of OpenStruct
|
7794
|
+
#
|
7795
|
+
# source://yard//lib/yard/open_struct.rb#5
|
7796
|
+
def initialize(hash = T.unsafe(nil)); end
|
7797
|
+
|
7798
|
+
# source://yard//lib/yard/open_struct.rb#25
|
7799
|
+
def ==(other); end
|
7800
|
+
|
7801
|
+
# source://yard//lib/yard/open_struct.rb#41
|
7802
|
+
def [](key); end
|
7803
|
+
|
7804
|
+
# source://yard//lib/yard/open_struct.rb#37
|
7805
|
+
def []=(key, value); end
|
7806
|
+
|
7807
|
+
# source://yard//lib/yard/open_struct.rb#33
|
7808
|
+
def dig(*keys); end
|
7809
|
+
|
7810
|
+
# source://yard//lib/yard/open_struct.rb#45
|
7811
|
+
def each_pair(&block); end
|
7812
|
+
|
7813
|
+
# source://yard//lib/yard/open_struct.rb#29
|
7814
|
+
def hash; end
|
7815
|
+
|
7816
|
+
# source://yard//lib/yard/open_struct.rb#49
|
7817
|
+
def marshal_dump; end
|
7818
|
+
|
7819
|
+
# source://yard//lib/yard/open_struct.rb#53
|
7820
|
+
def marshal_load(data); end
|
7821
|
+
|
7822
|
+
# @private
|
7823
|
+
#
|
7824
|
+
# source://yard//lib/yard/open_struct.rb#10
|
7825
|
+
def method_missing(name, *args); end
|
7826
|
+
|
7827
|
+
# source://yard//lib/yard/open_struct.rb#21
|
7828
|
+
def to_h; end
|
7829
|
+
|
7830
|
+
private
|
7831
|
+
|
7832
|
+
# source://yard//lib/yard/open_struct.rb#59
|
7833
|
+
def __cache_lookup__(name); end
|
7834
|
+
end
|
7835
|
+
|
7683
7836
|
# Generalized options class for passing around large amounts of options between objects.
|
7684
7837
|
#
|
7685
7838
|
# The options class exists for better visibility and documentability of options being
|
@@ -8231,7 +8384,7 @@ end
|
|
8231
8384
|
#
|
8232
8385
|
# @see Processor#parse_remaining_files
|
8233
8386
|
#
|
8234
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8387
|
+
# source://yard//lib/yard/parser/source_parser.rb#20
|
8235
8388
|
class YARD::Parser::OrderedParser
|
8236
8389
|
# Creates a new OrderedParser with the global state and a list
|
8237
8390
|
# of files to parse.
|
@@ -8243,30 +8396,30 @@ class YARD::Parser::OrderedParser
|
|
8243
8396
|
# @param files [Array<String>] the list of files to parse
|
8244
8397
|
# @return [OrderedParser] a new instance of OrderedParser
|
8245
8398
|
#
|
8246
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8399
|
+
# source://yard//lib/yard/parser/source_parser.rb#32
|
8247
8400
|
def initialize(global_state, files); end
|
8248
8401
|
|
8249
8402
|
# @return [Array<String>] the list of remaining files to parse
|
8250
8403
|
#
|
8251
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8404
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8252
8405
|
def files; end
|
8253
8406
|
|
8254
8407
|
# @return [Array<String>] the list of remaining files to parse
|
8255
8408
|
#
|
8256
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8409
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8257
8410
|
def files=(_arg0); end
|
8258
8411
|
|
8259
8412
|
# Parses the remainder of the {#files} list.
|
8260
8413
|
#
|
8261
8414
|
# @see Processor#parse_remaining_files
|
8262
8415
|
#
|
8263
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8416
|
+
# source://yard//lib/yard/parser/source_parser.rb#41
|
8264
8417
|
def parse; end
|
8265
8418
|
end
|
8266
8419
|
|
8267
8420
|
# Raised when the parser sees a Ruby syntax error
|
8268
8421
|
#
|
8269
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8422
|
+
# source://yard//lib/yard/parser/source_parser.rb#12
|
8270
8423
|
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
|
8271
8424
|
|
8272
8425
|
# Ruby parsing components.
|
@@ -8711,6 +8864,9 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8711
8864
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#430
|
8712
8865
|
def continue; end
|
8713
8866
|
|
8867
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1116
|
8868
|
+
def dedent(str); end
|
8869
|
+
|
8714
8870
|
# Returns the value of attribute exception_on_syntax_error.
|
8715
8871
|
#
|
8716
8872
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#463
|
@@ -8735,7 +8891,7 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8735
8891
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#488
|
8736
8892
|
def gets; end
|
8737
8893
|
|
8738
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8894
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1272
|
8739
8895
|
def identify_comment; end
|
8740
8896
|
|
8741
8897
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#945
|
@@ -8747,13 +8903,13 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8747
8903
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#980
|
8748
8904
|
def identify_identifier; end
|
8749
8905
|
|
8750
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8906
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1145
|
8751
8907
|
def identify_number(start); end
|
8752
8908
|
|
8753
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8909
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1126
|
8754
8910
|
def identify_quotation(initial_char); end
|
8755
8911
|
|
8756
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8912
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1207
|
8757
8913
|
def identify_string(ltype, quoted = T.unsafe(nil), opener = T.unsafe(nil), initial_char = T.unsafe(nil)); end
|
8758
8914
|
|
8759
8915
|
# Returns the value of attribute indent.
|
@@ -8800,10 +8956,10 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8800
8956
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#462
|
8801
8957
|
def read_auto_clean_up=(_arg0); end
|
8802
8958
|
|
8803
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8959
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1295
|
8804
8960
|
def read_escape; end
|
8805
8961
|
|
8806
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8962
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1257
|
8807
8963
|
def skip_inner_expression; end
|
8808
8964
|
|
8809
8965
|
# Returns the value of attribute skip_space.
|
@@ -10992,7 +11148,7 @@ end
|
|
10992
11148
|
# @see Handlers::Base
|
10993
11149
|
# @see CodeObjects::Base
|
10994
11150
|
#
|
10995
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11151
|
+
# source://yard//lib/yard/parser/source_parser.rb#63
|
10996
11152
|
class YARD::Parser::SourceParser
|
10997
11153
|
# @overload initialize
|
10998
11154
|
# @return [SourceParser] a new instance of SourceParser
|
@@ -11248,7 +11404,7 @@ class YARD::Parser::SourceParser
|
|
11248
11404
|
# {YARD::Logger}
|
11249
11405
|
# @return [void]
|
11250
11406
|
#
|
11251
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11407
|
+
# source://yard//lib/yard/parser/source_parser.rb#99
|
11252
11408
|
def parse(paths = T.unsafe(nil), excluded = T.unsafe(nil), level = T.unsafe(nil)); end
|
11253
11409
|
|
11254
11410
|
# Parses a string +content+
|
@@ -11262,10 +11418,10 @@ class YARD::Parser::SourceParser
|
|
11262
11418
|
|
11263
11419
|
# @return [Symbol] the default parser type (defaults to :ruby)
|
11264
11420
|
#
|
11265
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11421
|
+
# source://yard//lib/yard/parser/source_parser.rb#85
|
11266
11422
|
def parser_type; end
|
11267
11423
|
|
11268
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11424
|
+
# source://yard//lib/yard/parser/source_parser.rb#87
|
11269
11425
|
def parser_type=(value); end
|
11270
11426
|
|
11271
11427
|
# @private
|
@@ -11346,30 +11502,30 @@ end
|
|
11346
11502
|
#
|
11347
11503
|
# @since 0.9.0
|
11348
11504
|
#
|
11349
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11505
|
+
# source://yard//lib/yard/parser/source_parser.rb#70
|
11350
11506
|
YARD::Parser::SourceParser::DEFAULT_PATH_GLOB = T.let(T.unsafe(nil), Array)
|
11351
11507
|
|
11352
11508
|
# Byte order marks for various encodings
|
11353
11509
|
#
|
11354
11510
|
# @since 0.7.0
|
11355
11511
|
#
|
11356
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11512
|
+
# source://yard//lib/yard/parser/source_parser.rb#74
|
11357
11513
|
YARD::Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS = T.let(T.unsafe(nil), Hash)
|
11358
11514
|
|
11359
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11515
|
+
# source://yard//lib/yard/parser/source_parser.rb#65
|
11360
11516
|
YARD::Parser::SourceParser::ENCODING_LINE = T.let(T.unsafe(nil), Regexp)
|
11361
11517
|
|
11362
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11518
|
+
# source://yard//lib/yard/parser/source_parser.rb#66
|
11363
11519
|
YARD::Parser::SourceParser::FROZEN_STRING_LINE = T.let(T.unsafe(nil), Regexp)
|
11364
11520
|
|
11365
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11521
|
+
# source://yard//lib/yard/parser/source_parser.rb#64
|
11366
11522
|
YARD::Parser::SourceParser::SHEBANG_LINE = T.let(T.unsafe(nil), Regexp)
|
11367
11523
|
|
11368
11524
|
# Raised when an object is recognized but cannot be documented. This
|
11369
11525
|
# generally occurs when the Ruby syntax used to declare an object is
|
11370
11526
|
# too dynamic in nature.
|
11371
11527
|
#
|
11372
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11528
|
+
# source://yard//lib/yard/parser/source_parser.rb#9
|
11373
11529
|
class YARD::Parser::UndocumentableError < ::RuntimeError; end
|
11374
11530
|
|
11375
11531
|
# The root path for YARD source libraries
|
@@ -14688,42 +14844,42 @@ module YARD::Tags; end
|
|
14688
14844
|
# @see tag:!method
|
14689
14845
|
# @since 0.7.0
|
14690
14846
|
#
|
14691
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14847
|
+
# source://yard//lib/yard/tags/directives.rb#460
|
14692
14848
|
class YARD::Tags::AttributeDirective < ::YARD::Tags::MethodDirective
|
14693
14849
|
# @since 0.7.0
|
14694
14850
|
#
|
14695
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14851
|
+
# source://yard//lib/yard/tags/directives.rb#461
|
14696
14852
|
def after_parse; end
|
14697
14853
|
|
14698
14854
|
protected
|
14699
14855
|
|
14700
14856
|
# @since 0.7.0
|
14701
14857
|
#
|
14702
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14858
|
+
# source://yard//lib/yard/tags/directives.rb#469
|
14703
14859
|
def method_name; end
|
14704
14860
|
|
14705
14861
|
# @since 0.7.0
|
14706
14862
|
#
|
14707
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14863
|
+
# source://yard//lib/yard/tags/directives.rb#475
|
14708
14864
|
def method_signature; end
|
14709
14865
|
|
14710
14866
|
private
|
14711
14867
|
|
14712
14868
|
# @since 0.7.0
|
14713
14869
|
#
|
14714
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14870
|
+
# source://yard//lib/yard/tags/directives.rb#485
|
14715
14871
|
def create_attribute_data(object); end
|
14716
14872
|
|
14717
14873
|
# @return [Boolean]
|
14718
14874
|
# @since 0.7.0
|
14719
14875
|
#
|
14720
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14876
|
+
# source://yard//lib/yard/tags/directives.rb#515
|
14721
14877
|
def readable?; end
|
14722
14878
|
|
14723
14879
|
# @return [Boolean]
|
14724
14880
|
# @since 0.7.0
|
14725
14881
|
#
|
14726
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14882
|
+
# source://yard//lib/yard/tags/directives.rb#511
|
14727
14883
|
def writable?; end
|
14728
14884
|
end
|
14729
14885
|
|
@@ -14857,14 +15013,14 @@ end
|
|
14857
15013
|
# @see Library.define_directive
|
14858
15014
|
# @since 0.8.0
|
14859
15015
|
#
|
14860
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15016
|
+
# source://yard//lib/yard/tags/directives.rb#22
|
14861
15017
|
class YARD::Tags::Directive
|
14862
15018
|
# @param tag [Tag] the meta-data tag containing all input to the docstring
|
14863
15019
|
# @param parser [DocstringParser] the docstring parser object
|
14864
15020
|
# @return [Directive] a new instance of Directive
|
14865
15021
|
# @since 0.8.0
|
14866
15022
|
#
|
14867
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15023
|
+
# source://yard//lib/yard/tags/directives.rb#54
|
14868
15024
|
def initialize(tag, parser); end
|
14869
15025
|
|
14870
15026
|
# Called after parsing all directives and tags in the docstring. Used
|
@@ -14873,7 +15029,7 @@ class YARD::Tags::Directive
|
|
14873
15029
|
# @return [void]
|
14874
15030
|
# @since 0.8.0
|
14875
15031
|
#
|
14876
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15032
|
+
# source://yard//lib/yard/tags/directives.rb#73
|
14877
15033
|
def after_parse; end
|
14878
15034
|
|
14879
15035
|
# Called when processing the directive. Subclasses should implement
|
@@ -14885,7 +15041,7 @@ class YARD::Tags::Directive
|
|
14885
15041
|
# @return [void]
|
14886
15042
|
# @since 0.8.0
|
14887
15043
|
#
|
14888
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15044
|
+
# source://yard//lib/yard/tags/directives.rb#68
|
14889
15045
|
def call; end
|
14890
15046
|
|
14891
15047
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14897,7 +15053,7 @@ class YARD::Tags::Directive
|
|
14897
15053
|
# @return [nil] if no expansion should take place for this directive
|
14898
15054
|
# @since 0.8.0
|
14899
15055
|
#
|
14900
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15056
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14901
15057
|
def expanded_text; end
|
14902
15058
|
|
14903
15059
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14909,7 +15065,7 @@ class YARD::Tags::Directive
|
|
14909
15065
|
# @return [nil] if no expansion should take place for this directive
|
14910
15066
|
# @since 0.8.0
|
14911
15067
|
#
|
14912
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15068
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14913
15069
|
def expanded_text=(_arg0); end
|
14914
15070
|
|
14915
15071
|
# @return [Handlers::Base, nil] the handler object the docstring parser
|
@@ -14917,33 +15073,33 @@ class YARD::Tags::Directive
|
|
14917
15073
|
# through {Parser::SourceParser}.
|
14918
15074
|
# @since 0.8.0
|
14919
15075
|
#
|
14920
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15076
|
+
# source://yard//lib/yard/tags/directives.rb#48
|
14921
15077
|
def handler; end
|
14922
15078
|
|
14923
15079
|
# @return [CodeObjects::Base, nil] the object the parent docstring is
|
14924
15080
|
# attached to. May be nil.
|
14925
15081
|
# @since 0.8.0
|
14926
15082
|
#
|
14927
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15083
|
+
# source://yard//lib/yard/tags/directives.rb#42
|
14928
15084
|
def object; end
|
14929
15085
|
|
14930
15086
|
# @return [DocstringParser] the parser that is parsing all tag
|
14931
15087
|
# information out of the docstring
|
14932
15088
|
# @since 0.8.0
|
14933
15089
|
#
|
14934
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15090
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14935
15091
|
def parser=(_arg0); end
|
14936
15092
|
|
14937
15093
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14938
15094
|
# @since 0.8.0
|
14939
15095
|
#
|
14940
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15096
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14941
15097
|
def tag; end
|
14942
15098
|
|
14943
15099
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14944
15100
|
# @since 0.8.0
|
14945
15101
|
#
|
14946
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15102
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14947
15103
|
def tag=(_arg0); end
|
14948
15104
|
|
14949
15105
|
protected
|
@@ -14951,14 +15107,14 @@ class YARD::Tags::Directive
|
|
14951
15107
|
# @return [Boolean]
|
14952
15108
|
# @since 0.8.0
|
14953
15109
|
#
|
14954
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15110
|
+
# source://yard//lib/yard/tags/directives.rb#79
|
14955
15111
|
def inside_directive?; end
|
14956
15112
|
|
14957
15113
|
# @return [DocstringParser] the parser that is parsing all tag
|
14958
15114
|
# information out of the docstring
|
14959
15115
|
# @since 0.8.0
|
14960
15116
|
#
|
14961
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15117
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14962
15118
|
def parser; end
|
14963
15119
|
end
|
14964
15120
|
|
@@ -14982,11 +15138,11 @@ end
|
|
14982
15138
|
# @see tag:!group
|
14983
15139
|
# @since 0.6.0
|
14984
15140
|
#
|
14985
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15141
|
+
# source://yard//lib/yard/tags/directives.rb#104
|
14986
15142
|
class YARD::Tags::EndGroupDirective < ::YARD::Tags::Directive
|
14987
15143
|
# @since 0.6.0
|
14988
15144
|
#
|
14989
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15145
|
+
# source://yard//lib/yard/tags/directives.rb#105
|
14990
15146
|
def call; end
|
14991
15147
|
end
|
14992
15148
|
|
@@ -15007,11 +15163,11 @@ end
|
|
15007
15163
|
# @see tag:!endgroup
|
15008
15164
|
# @since 0.6.0
|
15009
15165
|
#
|
15010
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15166
|
+
# source://yard//lib/yard/tags/directives.rb#127
|
15011
15167
|
class YARD::Tags::GroupDirective < ::YARD::Tags::Directive
|
15012
15168
|
# @since 0.6.0
|
15013
15169
|
#
|
15014
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15170
|
+
# source://yard//lib/yard/tags/directives.rb#128
|
15015
15171
|
def call; end
|
15016
15172
|
end
|
15017
15173
|
|
@@ -15776,12 +15932,12 @@ end
|
|
15776
15932
|
# end
|
15777
15933
|
# @since 0.7.0
|
15778
15934
|
#
|
15779
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15935
|
+
# source://yard//lib/yard/tags/directives.rb#257
|
15780
15936
|
class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
15781
15937
|
# @raise [TagFormatError]
|
15782
15938
|
# @since 0.7.0
|
15783
15939
|
#
|
15784
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15940
|
+
# source://yard//lib/yard/tags/directives.rb#258
|
15785
15941
|
def call; end
|
15786
15942
|
|
15787
15943
|
private
|
@@ -15789,40 +15945,40 @@ class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
|
15789
15945
|
# @return [Boolean]
|
15790
15946
|
# @since 0.7.0
|
15791
15947
|
#
|
15792
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15948
|
+
# source://yard//lib/yard/tags/directives.rb#287
|
15793
15949
|
def anonymous?; end
|
15794
15950
|
|
15795
15951
|
# @return [Boolean]
|
15796
15952
|
# @since 0.7.0
|
15797
15953
|
#
|
15798
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15954
|
+
# source://yard//lib/yard/tags/directives.rb#276
|
15799
15955
|
def attach?; end
|
15800
15956
|
|
15801
15957
|
# @return [Boolean]
|
15802
15958
|
# @since 0.7.0
|
15803
15959
|
#
|
15804
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15960
|
+
# source://yard//lib/yard/tags/directives.rb#282
|
15805
15961
|
def class_method?; end
|
15806
15962
|
|
15807
15963
|
# @since 0.7.0
|
15808
15964
|
#
|
15809
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15965
|
+
# source://yard//lib/yard/tags/directives.rb#291
|
15810
15966
|
def expand(macro_data); end
|
15811
15967
|
|
15812
15968
|
# @since 0.7.0
|
15813
15969
|
#
|
15814
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15970
|
+
# source://yard//lib/yard/tags/directives.rb#307
|
15815
15971
|
def find_or_create; end
|
15816
15972
|
|
15817
15973
|
# @return [Boolean]
|
15818
15974
|
# @since 0.7.0
|
15819
15975
|
#
|
15820
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15976
|
+
# source://yard//lib/yard/tags/directives.rb#271
|
15821
15977
|
def new?; end
|
15822
15978
|
|
15823
15979
|
# @since 0.7.0
|
15824
15980
|
#
|
15825
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15981
|
+
# source://yard//lib/yard/tags/directives.rb#331
|
15826
15982
|
def warn; end
|
15827
15983
|
end
|
15828
15984
|
|
@@ -15855,49 +16011,49 @@ end
|
|
15855
16011
|
# @see tag:!attribute
|
15856
16012
|
# @since 0.7.0
|
15857
16013
|
#
|
15858
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16014
|
+
# source://yard//lib/yard/tags/directives.rb#367
|
15859
16015
|
class YARD::Tags::MethodDirective < ::YARD::Tags::Directive
|
15860
16016
|
# @since 0.7.0
|
15861
16017
|
#
|
15862
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16018
|
+
# source://yard//lib/yard/tags/directives.rb#372
|
15863
16019
|
def after_parse; end
|
15864
16020
|
|
15865
16021
|
# @since 0.7.0
|
15866
16022
|
#
|
15867
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16023
|
+
# source://yard//lib/yard/tags/directives.rb#370
|
15868
16024
|
def call; end
|
15869
16025
|
|
15870
16026
|
protected
|
15871
16027
|
|
15872
16028
|
# @since 0.7.0
|
15873
16029
|
#
|
15874
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16030
|
+
# source://yard//lib/yard/tags/directives.rb#412
|
15875
16031
|
def create_object; end
|
15876
16032
|
|
15877
16033
|
# @since 0.7.0
|
15878
16034
|
#
|
15879
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16035
|
+
# source://yard//lib/yard/tags/directives.rb#380
|
15880
16036
|
def method_name; end
|
15881
16037
|
|
15882
16038
|
# @since 0.7.0
|
15883
16039
|
#
|
15884
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16040
|
+
# source://yard//lib/yard/tags/directives.rb#389
|
15885
16041
|
def method_signature; end
|
15886
16042
|
|
15887
16043
|
# @since 0.7.0
|
15888
16044
|
#
|
15889
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16045
|
+
# source://yard//lib/yard/tags/directives.rb#393
|
15890
16046
|
def sanitized_tag_signature; end
|
15891
16047
|
|
15892
16048
|
# @since 0.7.0
|
15893
16049
|
#
|
15894
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16050
|
+
# source://yard//lib/yard/tags/directives.rb#402
|
15895
16051
|
def use_indented_text; end
|
15896
16052
|
end
|
15897
16053
|
|
15898
16054
|
# @since 0.7.0
|
15899
16055
|
#
|
15900
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16056
|
+
# source://yard//lib/yard/tags/directives.rb#368
|
15901
16057
|
YARD::Tags::MethodDirective::SCOPE_MATCH = T.let(T.unsafe(nil), Regexp)
|
15902
16058
|
|
15903
16059
|
# source://yard//lib/yard/tags/option_tag.rb#4
|
@@ -16009,11 +16165,11 @@ end
|
|
16009
16165
|
# # }
|
16010
16166
|
# @since 0.8.0
|
16011
16167
|
#
|
16012
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16168
|
+
# source://yard//lib/yard/tags/directives.rb#544
|
16013
16169
|
class YARD::Tags::ParseDirective < ::YARD::Tags::Directive
|
16014
16170
|
# @since 0.8.0
|
16015
16171
|
#
|
16016
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16172
|
+
# source://yard//lib/yard/tags/directives.rb#545
|
16017
16173
|
def call; end
|
16018
16174
|
end
|
16019
16175
|
|
@@ -16097,11 +16253,11 @@ end
|
|
16097
16253
|
# def method2; end
|
16098
16254
|
# @since 0.7.0
|
16099
16255
|
#
|
16100
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16256
|
+
# source://yard//lib/yard/tags/directives.rb#578
|
16101
16257
|
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
|
16102
16258
|
# @since 0.7.0
|
16103
16259
|
#
|
16104
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16260
|
+
# source://yard//lib/yard/tags/directives.rb#579
|
16105
16261
|
def call; end
|
16106
16262
|
end
|
16107
16263
|
|
@@ -16132,7 +16288,7 @@ class YARD::Tags::Tag
|
|
16132
16288
|
# @param name [String] optional key name which the tag refers to
|
16133
16289
|
# @return [Tag] a new instance of Tag
|
16134
16290
|
#
|
16135
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16291
|
+
# source://yard//lib/yard/tags/tag.rb#45
|
16136
16292
|
def initialize(tag_name, text, types = T.unsafe(nil), name = T.unsafe(nil)); end
|
16137
16293
|
|
16138
16294
|
# Provides a plain English summary of the type specification, or nil
|
@@ -16141,27 +16297,29 @@ class YARD::Tags::Tag
|
|
16141
16297
|
# @return [String] a plain English description of the associated types
|
16142
16298
|
# @return [nil] if no types are provided or not parsable
|
16143
16299
|
#
|
16144
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16300
|
+
# source://yard//lib/yard/tags/tag.rb#66
|
16145
16301
|
def explain_types; end
|
16146
16302
|
|
16147
16303
|
# @return [String] a name associated with the tag
|
16304
|
+
# @return [nil] if no tag name is supplied
|
16148
16305
|
#
|
16149
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16306
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16150
16307
|
def name; end
|
16151
16308
|
|
16152
16309
|
# @return [String] a name associated with the tag
|
16310
|
+
# @return [nil] if no tag name is supplied
|
16153
16311
|
#
|
16154
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16312
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16155
16313
|
def name=(_arg0); end
|
16156
16314
|
|
16157
16315
|
# @return [CodeObjects::Base] the associated object
|
16158
16316
|
#
|
16159
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16317
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16160
16318
|
def object; end
|
16161
16319
|
|
16162
16320
|
# @return [CodeObjects::Base] the associated object
|
16163
16321
|
#
|
16164
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16322
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16165
16323
|
def object=(_arg0); end
|
16166
16324
|
|
16167
16325
|
# @return [String] the name of the tag
|
@@ -16192,7 +16350,7 @@ class YARD::Tags::Tag
|
|
16192
16350
|
# @return [String] the first of the list of specified types
|
16193
16351
|
# @see #types
|
16194
16352
|
#
|
16195
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16353
|
+
# source://yard//lib/yard/tags/tag.rb#57
|
16196
16354
|
def type; end
|
16197
16355
|
|
16198
16356
|
# @return [Array<String>] a list of types associated with the tag
|
@@ -16383,11 +16541,11 @@ end
|
|
16383
16541
|
# def method2; end
|
16384
16542
|
# @since 0.7.0
|
16385
16543
|
#
|
16386
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16544
|
+
# source://yard//lib/yard/tags/directives.rb#610
|
16387
16545
|
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
|
16388
16546
|
# @since 0.7.0
|
16389
16547
|
#
|
16390
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16548
|
+
# source://yard//lib/yard/tags/directives.rb#611
|
16391
16549
|
def call; end
|
16392
16550
|
end
|
16393
16551
|
|
@@ -16403,7 +16561,7 @@ module YARD::Templates; end
|
|
16403
16561
|
# * To render a template, call {render}.
|
16404
16562
|
# * To register a template path in the lookup paths, call {register_template_path}.
|
16405
16563
|
#
|
16406
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16564
|
+
# source://yard//lib/yard/templates/engine.rb#11
|
16407
16565
|
module YARD::Templates::Engine
|
16408
16566
|
class << self
|
16409
16567
|
# Passes a set of objects to the +:fulldoc+ template for full documentation generation.
|
@@ -16415,7 +16573,7 @@ module YARD::Templates::Engine
|
|
16415
16573
|
# @param options [Hash] (see {render})
|
16416
16574
|
# @return [void]
|
16417
16575
|
#
|
16418
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16576
|
+
# source://yard//lib/yard/templates/engine.rb#100
|
16419
16577
|
def generate(objects, options = T.unsafe(nil)); end
|
16420
16578
|
|
16421
16579
|
# Registers a new template path in {template_paths}
|
@@ -16423,7 +16581,7 @@ module YARD::Templates::Engine
|
|
16423
16581
|
# @param path [String] a new template path
|
16424
16582
|
# @return [void]
|
16425
16583
|
#
|
16426
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16584
|
+
# source://yard//lib/yard/templates/engine.rb#20
|
16427
16585
|
def register_template_path(path); end
|
16428
16586
|
|
16429
16587
|
# Renders a template on a {CodeObjects::Base code object} using
|
@@ -16444,7 +16602,7 @@ module YARD::Templates::Engine
|
|
16444
16602
|
# @param options [Hash] the options hash
|
16445
16603
|
# @return [String] the rendered template
|
16446
16604
|
#
|
16447
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16605
|
+
# source://yard//lib/yard/templates/engine.rb#81
|
16448
16606
|
def render(options = T.unsafe(nil)); end
|
16449
16607
|
|
16450
16608
|
# Creates a template module representing the path. Searches on disk
|
@@ -16458,7 +16616,7 @@ module YARD::Templates::Engine
|
|
16458
16616
|
# {template_paths} on disk.
|
16459
16617
|
# @return [Template] the module representing the template
|
16460
16618
|
#
|
16461
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16619
|
+
# source://yard//lib/yard/templates/engine.rb#34
|
16462
16620
|
def template(*path); end
|
16463
16621
|
|
16464
16622
|
# Forces creation of a template at +path+ within a +full_path+.
|
@@ -16467,17 +16625,17 @@ module YARD::Templates::Engine
|
|
16467
16625
|
# @param full_paths [Array<String>] the full path on disk of the template
|
16468
16626
|
# @return [Template] the template module representing the +path+
|
16469
16627
|
#
|
16470
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16628
|
+
# source://yard//lib/yard/templates/engine.rb#52
|
16471
16629
|
def template!(path, full_paths = T.unsafe(nil)); end
|
16472
16630
|
|
16473
16631
|
# @return [Array<String>] the list of registered template paths
|
16474
16632
|
#
|
16475
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16633
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16476
16634
|
def template_paths; end
|
16477
16635
|
|
16478
16636
|
# @return [Array<String>] the list of registered template paths
|
16479
16637
|
#
|
16480
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16638
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16481
16639
|
def template_paths=(_arg0); end
|
16482
16640
|
|
16483
16641
|
# Serializes the results of a block with a +serializer+ object.
|
@@ -16488,7 +16646,7 @@ module YARD::Templates::Engine
|
|
16488
16646
|
# @yield a block whose result will be serialize
|
16489
16647
|
# @yieldreturn [String] the contents to serialize
|
16490
16648
|
#
|
16491
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16649
|
+
# source://yard//lib/yard/templates/engine.rb#114
|
16492
16650
|
def with_serializer(object, serializer); end
|
16493
16651
|
|
16494
16652
|
private
|
@@ -16503,7 +16661,7 @@ module YARD::Templates::Engine
|
|
16503
16661
|
# @return [Array<String>] a list of full paths that are existing
|
16504
16662
|
# candidates for a template module
|
16505
16663
|
#
|
16506
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16664
|
+
# source://yard//lib/yard/templates/engine.rb#160
|
16507
16665
|
def find_template_paths(from_template, path); end
|
16508
16666
|
|
16509
16667
|
# Sets default options on the options hash
|
@@ -16514,7 +16672,7 @@ module YARD::Templates::Engine
|
|
16514
16672
|
# @param options [Hash] the options hash
|
16515
16673
|
# @return [void]
|
16516
16674
|
#
|
16517
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16675
|
+
# source://yard//lib/yard/templates/engine.rb#140
|
16518
16676
|
def set_default_options(options = T.unsafe(nil)); end
|
16519
16677
|
|
16520
16678
|
# The name of the module that represents a +path+
|
@@ -16522,7 +16680,7 @@ module YARD::Templates::Engine
|
|
16522
16680
|
# @param path [String] the path to generate a module name for
|
16523
16681
|
# @return [String] the module name
|
16524
16682
|
#
|
16525
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16683
|
+
# source://yard//lib/yard/templates/engine.rb#175
|
16526
16684
|
def template_module_name(path); end
|
16527
16685
|
end
|
16528
16686
|
end
|
@@ -17933,7 +18091,7 @@ end
|
|
17933
18091
|
#
|
17934
18092
|
# @see CLI::YardocOptions
|
17935
18093
|
#
|
17936
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18094
|
+
# source://yard//lib/yard/templates/template_options.rb#9
|
17937
18095
|
class YARD::Templates::TemplateOptions < ::YARD::Options
|
17938
18096
|
# @return [OpenStruct] an open struct containing any global state across all
|
17939
18097
|
# generated objects in a template.
|
@@ -17976,7 +18134,7 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17976
18134
|
# @return [Boolean] whether a mixin matches the embed_mixins list
|
17977
18135
|
# @return [nil] if the mixin is not a module object
|
17978
18136
|
#
|
17979
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18137
|
+
# source://yard//lib/yard/templates/template_options.rb#77
|
17980
18138
|
def embed_mixins_match?(mixin); end
|
17981
18139
|
|
17982
18140
|
# @return [Symbol] the template output format
|
@@ -18023,12 +18181,12 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18023
18181
|
|
18024
18182
|
# @return [Boolean] whether the page is the "index"
|
18025
18183
|
#
|
18026
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18184
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
18027
18185
|
def index; end
|
18028
18186
|
|
18029
18187
|
# @return [Boolean] whether the page is the "index"
|
18030
18188
|
#
|
18031
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18189
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
18032
18190
|
def index=(_arg0); end
|
18033
18191
|
|
18034
18192
|
# @return [Symbol] the markup format to use when parsing docstrings
|
@@ -18043,51 +18201,51 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18043
18201
|
|
18044
18202
|
# @return [Class] the markup provider class for the markup format
|
18045
18203
|
#
|
18046
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18204
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
18047
18205
|
def markup_provider; end
|
18048
18206
|
|
18049
18207
|
# @return [Class] the markup provider class for the markup format
|
18050
18208
|
#
|
18051
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18209
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
18052
18210
|
def markup_provider=(_arg0); end
|
18053
18211
|
|
18054
18212
|
# @deprecated use {#highlight} instead.
|
18055
18213
|
# @return [Boolean] whether highlighting should be ignored
|
18056
18214
|
#
|
18057
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18215
|
+
# source://yard//lib/yard/templates/template_options.rb#56
|
18058
18216
|
def no_highlight; end
|
18059
18217
|
|
18060
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18218
|
+
# source://yard//lib/yard/templates/template_options.rb#57
|
18061
18219
|
def no_highlight=(value); end
|
18062
18220
|
|
18063
18221
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18064
18222
|
#
|
18065
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18223
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18066
18224
|
def object; end
|
18067
18225
|
|
18068
18226
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18069
18227
|
#
|
18070
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18228
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18071
18229
|
def object=(_arg0); end
|
18072
18230
|
|
18073
18231
|
# @return [CodeObjects::Base] the owner of the generated object
|
18074
18232
|
#
|
18075
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18233
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18076
18234
|
def owner; end
|
18077
18235
|
|
18078
18236
|
# @return [CodeObjects::Base] the owner of the generated object
|
18079
18237
|
#
|
18080
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18238
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18081
18239
|
def owner=(_arg0); end
|
18082
18240
|
|
18083
18241
|
# @return [String] the title of a given page
|
18084
18242
|
#
|
18085
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18243
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18086
18244
|
def page_title; end
|
18087
18245
|
|
18088
18246
|
# @return [String] the title of a given page
|
18089
18247
|
#
|
18090
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18248
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18091
18249
|
def page_title=(_arg0); end
|
18092
18250
|
|
18093
18251
|
# @return [Boolean] whether serialization should be performed
|
@@ -18103,13 +18261,13 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18103
18261
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18104
18262
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18105
18263
|
#
|
18106
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18264
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18107
18265
|
def serializer; end
|
18108
18266
|
|
18109
18267
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18110
18268
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18111
18269
|
#
|
18112
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18270
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18113
18271
|
def serializer=(_arg0); end
|
18114
18272
|
|
18115
18273
|
# @return [Symbol] the template name used to render output
|
@@ -18124,22 +18282,22 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18124
18282
|
|
18125
18283
|
# @return [Symbol] the template type used to generate output
|
18126
18284
|
#
|
18127
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18285
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18128
18286
|
def type; end
|
18129
18287
|
|
18130
18288
|
# @return [Symbol] the template type used to generate output
|
18131
18289
|
#
|
18132
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18290
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18133
18291
|
def type=(_arg0); end
|
18134
18292
|
|
18135
18293
|
# @return [Verifier] the verifier object
|
18136
18294
|
#
|
18137
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18295
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18138
18296
|
def verifier; end
|
18139
18297
|
|
18140
18298
|
# @return [Verifier] the verifier object
|
18141
18299
|
#
|
18142
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18300
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18143
18301
|
def verifier=(_arg0); end
|
18144
18302
|
end
|
18145
18303
|
|