sorbet-result 1.1.0 → 1.3.0
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/.ruby-version +1 -1
- data/.standard.yml +1 -1
- data/CHANGELOG.md +17 -0
- data/Gemfile +1 -1
- data/Gemfile.lock +85 -68
- data/README.md +4 -4
- data/lib/typed/no_payload_on_failure_error.rb +8 -3
- data/lib/typed/result.rb +33 -3
- data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi} +4 -3
- data/sorbet/rbi/gems/benchmark@0.4.1.rbi +619 -0
- data/sorbet/rbi/gems/cgi@0.5.0.rbi +2961 -0
- data/sorbet/rbi/gems/date@3.4.1.rbi +75 -0
- data/sorbet/rbi/gems/erb@4.0.4.rbi +910 -0
- data/sorbet/rbi/gems/{erubi@1.12.0.rbi → erubi@1.13.1.rbi} +25 -15
- data/sorbet/rbi/gems/{io-console@0.7.2.rbi → io-console@0.8.0.rbi} +1 -0
- data/sorbet/rbi/gems/{json@2.7.1.rbi → json@2.12.2.rbi} +736 -238
- data/sorbet/rbi/gems/{language_server-protocol@3.17.0.3.rbi → language_server-protocol@3.17.0.5.rbi} +12 -5
- data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +1 -0
- data/sorbet/rbi/gems/logger@1.7.0.rbi +963 -0
- data/sorbet/rbi/gems/{minitest@5.22.2.rbi → minitest@5.25.5.rbi} +326 -308
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +1 -0
- data/sorbet/rbi/gems/{parallel@1.24.0.rbi → parallel@1.27.0.rbi} +32 -21
- data/sorbet/rbi/gems/{parser@3.3.0.5.rbi → parser@3.3.8.0.rbi} +448 -385
- data/sorbet/rbi/gems/pp@0.6.2.rbi +368 -0
- data/sorbet/rbi/gems/prettyprint@0.2.0.rbi +477 -0
- data/sorbet/rbi/gems/prism@1.4.0.rbi +41732 -0
- data/sorbet/rbi/gems/{psych@5.1.2.rbi → psych@5.2.6.rbi} +974 -236
- data/sorbet/rbi/gems/{racc@1.7.3.rbi → racc@1.8.1.rbi} +38 -33
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +1 -0
- data/sorbet/rbi/gems/{rake@13.1.0.rbi → rake@13.3.0.rbi} +62 -58
- data/sorbet/rbi/gems/rbi@0.3.6.rbi +6893 -0
- data/sorbet/rbi/gems/rbs@3.9.4.rbi +6976 -0
- data/sorbet/rbi/gems/{regexp_parser@2.9.0.rbi → regexp_parser@2.10.0.rbi} +196 -172
- data/sorbet/rbi/gems/{reline@0.4.2.rbi → reline@0.6.1.rbi} +1 -0
- data/sorbet/rbi/gems/{rubocop-ast@1.30.0.rbi → rubocop-ast@1.45.1.rbi} +1673 -958
- data/sorbet/rbi/gems/{rubocop-performance@1.20.2.rbi → rubocop-performance@1.25.0.rbi} +1 -0
- data/sorbet/rbi/gems/{rubocop-sorbet@0.7.7.rbi → rubocop-sorbet@0.9.0.rbi} +1 -0
- data/sorbet/rbi/gems/{rubocop@1.60.2.rbi → rubocop@1.75.8.rbi} +9990 -5267
- data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +1 -0
- data/sorbet/rbi/gems/spoom@1.6.1.rbi +7274 -0
- data/sorbet/rbi/gems/standard-custom@1.0.2.rbi +1 -0
- data/sorbet/rbi/gems/{standard-performance@1.3.1.rbi → standard-performance@1.8.0.rbi} +1 -0
- data/sorbet/rbi/gems/{standard-sorbet@0.0.2.rbi → standard-sorbet@0.0.3.rbi} +1 -0
- data/sorbet/rbi/gems/{standard@1.34.0.rbi → standard@1.50.0.rbi} +182 -97
- data/sorbet/rbi/gems/{stringio@3.1.0.rbi → stringio@3.1.7.rbi} +1 -0
- data/sorbet/rbi/gems/{tapioca@0.12.0.rbi → tapioca@0.16.11.rbi} +489 -364
- data/sorbet/rbi/gems/{thor@1.3.0.rbi → thor@1.3.2.rbi} +114 -81
- 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/{yard-sorbet@0.8.1.rbi → yard-sorbet@0.9.0.rbi} +36 -29
- data/sorbet/rbi/gems/{yard@0.9.34.rbi → yard@0.9.37.rbi} +430 -270
- metadata +46 -55
- data/.tool-versions +0 -1
- data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +0 -951
- data/sorbet/rbi/gems/prism@0.24.0.rbi +0 -31040
- data/sorbet/rbi/gems/rbi@0.1.9.rbi +0 -3006
- data/sorbet/rbi/gems/rexml@3.2.6.rbi +0 -4781
- data/sorbet/rbi/gems/spoom@1.2.4.rbi +0 -3777
- data/sorbet/rbi/gems/syntax_tree@6.2.0.rbi +0 -23133
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -65
@@ -4,6 +4,7 @@
|
|
4
4
|
# This is an autogenerated file for types exported from the `yard` gem.
|
5
5
|
# Please instead update this file by running `bin/tapioca gem yard`.
|
6
6
|
|
7
|
+
|
7
8
|
# source://yard//lib/yard.rb#61
|
8
9
|
::RUBY18 = T.let(T.unsafe(nil), FalseClass)
|
9
10
|
|
@@ -2480,7 +2481,7 @@ class YARD::CodeObjects::Base
|
|
2480
2481
|
# the paths are equal
|
2481
2482
|
# @return [Boolean] whether or not the objects are considered the same
|
2482
2483
|
#
|
2483
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2484
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2484
2485
|
def ==(other); end
|
2485
2486
|
|
2486
2487
|
# Accesses a custom attribute on the object
|
@@ -2489,7 +2490,7 @@ class YARD::CodeObjects::Base
|
|
2489
2490
|
# @return [Object, nil] the custom attribute or nil if not found.
|
2490
2491
|
# @see #[]=
|
2491
2492
|
#
|
2492
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2493
|
+
# source://yard//lib/yard/code_objects/base.rb#343
|
2493
2494
|
def [](key); end
|
2494
2495
|
|
2495
2496
|
# Sets a custom attribute on the object
|
@@ -2499,7 +2500,7 @@ class YARD::CodeObjects::Base
|
|
2499
2500
|
# @return [void]
|
2500
2501
|
# @see #[]
|
2501
2502
|
#
|
2502
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2503
|
+
# source://yard//lib/yard/code_objects/base.rb#356
|
2503
2504
|
def []=(key, value); end
|
2504
2505
|
|
2505
2506
|
# Associates a file with a code object, optionally adding the line where it was defined.
|
@@ -2520,7 +2521,7 @@ class YARD::CodeObjects::Base
|
|
2520
2521
|
# @see Docstring#add_tag
|
2521
2522
|
# @since 0.8.4
|
2522
2523
|
#
|
2523
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2524
|
+
# source://yard//lib/yard/code_objects/base.rb#561
|
2524
2525
|
def add_tag(*tags); end
|
2525
2526
|
|
2526
2527
|
# The non-localized documentation string associated with the object
|
@@ -2547,7 +2548,7 @@ class YARD::CodeObjects::Base
|
|
2547
2548
|
# the locale of the documentation string.
|
2548
2549
|
# @return [Docstring] the documentation string
|
2549
2550
|
#
|
2550
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2551
|
+
# source://yard//lib/yard/code_objects/base.rb#405
|
2551
2552
|
def docstring(locale = T.unsafe(nil)); end
|
2552
2553
|
|
2553
2554
|
# Attaches a docstring to a code object by parsing the comments attached to the statement
|
@@ -2556,7 +2557,7 @@ class YARD::CodeObjects::Base
|
|
2556
2557
|
# @param comments [String, Array<String>, Docstring] the comments attached to the code object to be parsed
|
2557
2558
|
# into a docstring and meta tags.
|
2558
2559
|
#
|
2559
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2560
|
+
# source://yard//lib/yard/code_objects/base.rb#427
|
2560
2561
|
def docstring=(comments); end
|
2561
2562
|
|
2562
2563
|
# Marks whether or not the method is conditionally defined at runtime
|
@@ -2587,7 +2588,7 @@ class YARD::CodeObjects::Base
|
|
2587
2588
|
# the paths are equal
|
2588
2589
|
# @return [Boolean] whether or not the objects are considered the same
|
2589
2590
|
#
|
2590
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2591
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2591
2592
|
def eql?(other); end
|
2592
2593
|
|
2593
2594
|
# Tests if another object is equal to this, including a proxy
|
@@ -2596,15 +2597,16 @@ class YARD::CodeObjects::Base
|
|
2596
2597
|
# the paths are equal
|
2597
2598
|
# @return [Boolean] whether or not the objects are considered the same
|
2598
2599
|
#
|
2599
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2600
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2600
2601
|
def equal?(other); end
|
2601
2602
|
|
2602
2603
|
# Returns the filename the object was first parsed at, taking
|
2603
2604
|
# definitions with docstrings first.
|
2604
2605
|
#
|
2605
2606
|
# @return [String] a filename
|
2607
|
+
# @return [nil] if there is no file associated with the object
|
2606
2608
|
#
|
2607
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2609
|
+
# source://yard//lib/yard/code_objects/base.rb#307
|
2608
2610
|
def file; end
|
2609
2611
|
|
2610
2612
|
# The files the object was defined in. To add a file, use {#add_file}.
|
@@ -2629,7 +2631,7 @@ class YARD::CodeObjects::Base
|
|
2629
2631
|
# @return [String] the rendered template
|
2630
2632
|
# @see Templates::Engine#render
|
2631
2633
|
#
|
2632
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2634
|
+
# source://yard//lib/yard/code_objects/base.rb#505
|
2633
2635
|
def format(options = T.unsafe(nil)); end
|
2634
2636
|
|
2635
2637
|
# @return [String] the group this object is associated with
|
@@ -2649,19 +2651,19 @@ class YARD::CodeObjects::Base
|
|
2649
2651
|
# @return [Boolean]
|
2650
2652
|
# @see Docstring#has_tag?
|
2651
2653
|
#
|
2652
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2654
|
+
# source://yard//lib/yard/code_objects/base.rb#556
|
2653
2655
|
def has_tag?(name); end
|
2654
2656
|
|
2655
2657
|
# @return [Integer] the object's hash value (for equality checking)
|
2656
2658
|
#
|
2657
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2659
|
+
# source://yard//lib/yard/code_objects/base.rb#334
|
2658
2660
|
def hash; end
|
2659
2661
|
|
2660
2662
|
# Inspects the object, returning the type and path
|
2661
2663
|
#
|
2662
2664
|
# @return [String] a string describing the object
|
2663
2665
|
#
|
2664
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2666
|
+
# source://yard//lib/yard/code_objects/base.rb#513
|
2665
2667
|
def inspect; end
|
2666
2668
|
|
2667
2669
|
# Returns the line the object was first parsed at (or nil)
|
@@ -2669,13 +2671,13 @@ class YARD::CodeObjects::Base
|
|
2669
2671
|
# @return [Fixnum] the line where the object was first defined.
|
2670
2672
|
# @return [nil] if there is no line associated with the object
|
2671
2673
|
#
|
2672
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2674
|
+
# source://yard//lib/yard/code_objects/base.rb#315
|
2673
2675
|
def line; end
|
2674
2676
|
|
2675
2677
|
# @overload dynamic_attr_name
|
2676
2678
|
# @overload dynamic_attr_name=
|
2677
2679
|
#
|
2678
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2680
|
+
# source://yard//lib/yard/code_objects/base.rb#373
|
2679
2681
|
def method_missing(meth, *args, &block); end
|
2680
2682
|
|
2681
2683
|
# The name of the object
|
@@ -2703,7 +2705,7 @@ class YARD::CodeObjects::Base
|
|
2703
2705
|
# for {Registry.root}). If obj is nil, the object is unregistered
|
2704
2706
|
# from the Registry.
|
2705
2707
|
#
|
2706
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2708
|
+
# source://yard//lib/yard/code_objects/base.rb#522
|
2707
2709
|
def namespace=(obj); end
|
2708
2710
|
|
2709
2711
|
# The namespace the object is defined in. If the object is in the
|
@@ -2720,7 +2722,7 @@ class YARD::CodeObjects::Base
|
|
2720
2722
|
# for {Registry.root}). If obj is nil, the object is unregistered
|
2721
2723
|
# from the Registry.
|
2722
2724
|
#
|
2723
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2725
|
+
# source://yard//lib/yard/code_objects/base.rb#522
|
2724
2726
|
def parent=(obj); end
|
2725
2727
|
|
2726
2728
|
# Represents the unique path of the object. The default implementation
|
@@ -2733,19 +2735,19 @@ class YARD::CodeObjects::Base
|
|
2733
2735
|
# @return [String] the unique path of the object
|
2734
2736
|
# @see #sep
|
2735
2737
|
#
|
2736
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2738
|
+
# source://yard//lib/yard/code_objects/base.rb#453
|
2737
2739
|
def path; end
|
2738
2740
|
|
2739
2741
|
# @param other [Base, String] another code object (or object path)
|
2740
2742
|
# @return [String] the shortest relative path from this object to +other+
|
2741
2743
|
# @since 0.5.3
|
2742
2744
|
#
|
2743
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2745
|
+
# source://yard//lib/yard/code_objects/base.rb#475
|
2744
2746
|
def relative_path(other); end
|
2745
2747
|
|
2746
2748
|
# @return [Boolean] whether or not this object is a RootObject
|
2747
2749
|
#
|
2748
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2750
|
+
# source://yard//lib/yard/code_objects/base.rb#567
|
2749
2751
|
def root?; end
|
2750
2752
|
|
2751
2753
|
# Override this method with a custom component separator. For instance,
|
@@ -2756,7 +2758,7 @@ class YARD::CodeObjects::Base
|
|
2756
2758
|
# @return [String] the component that separates the namespace path
|
2757
2759
|
# and the name (default is {NSEP})
|
2758
2760
|
#
|
2759
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2761
|
+
# source://yard//lib/yard/code_objects/base.rb#576
|
2760
2762
|
def sep; end
|
2761
2763
|
|
2762
2764
|
# The one line signature representing an object. For a method, this will
|
@@ -2789,7 +2791,7 @@ class YARD::CodeObjects::Base
|
|
2789
2791
|
# @param statement [#source, String] the +Parser::Statement+ holding the source code or the raw source
|
2790
2792
|
# as a +String+ for the definition of the code object only (not the block)
|
2791
2793
|
#
|
2792
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2794
|
+
# source://yard//lib/yard/code_objects/base.rb#388
|
2793
2795
|
def source=(statement); end
|
2794
2796
|
|
2795
2797
|
# Language of the source code associated with the object. Defaults to
|
@@ -2812,14 +2814,14 @@ class YARD::CodeObjects::Base
|
|
2812
2814
|
#
|
2813
2815
|
# @see Docstring#tag
|
2814
2816
|
#
|
2815
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2817
|
+
# source://yard//lib/yard/code_objects/base.rb#548
|
2816
2818
|
def tag(name); end
|
2817
2819
|
|
2818
2820
|
# Gets a list of tags from the {#docstring}
|
2819
2821
|
#
|
2820
2822
|
# @see Docstring#tags
|
2821
2823
|
#
|
2822
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2824
|
+
# source://yard//lib/yard/code_objects/base.rb#552
|
2823
2825
|
def tags(name = T.unsafe(nil)); end
|
2824
2826
|
|
2825
2827
|
# @note Override this method if your object has a special title that does
|
@@ -2828,12 +2830,12 @@ class YARD::CodeObjects::Base
|
|
2828
2830
|
# @return [String] the display title for an object
|
2829
2831
|
# @see 0.8.4
|
2830
2832
|
#
|
2831
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2833
|
+
# source://yard//lib/yard/code_objects/base.rb#468
|
2832
2834
|
def title; end
|
2833
2835
|
|
2834
2836
|
# @return [nil] this object does not turn into an array
|
2835
2837
|
#
|
2836
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2838
|
+
# source://yard//lib/yard/code_objects/base.rb#337
|
2837
2839
|
def to_ary; end
|
2838
2840
|
|
2839
2841
|
# Represents the unique path of the object. The default implementation
|
@@ -2846,7 +2848,7 @@ class YARD::CodeObjects::Base
|
|
2846
2848
|
# @return [String] the unique path of the object
|
2847
2849
|
# @see #sep
|
2848
2850
|
#
|
2849
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2851
|
+
# source://yard//lib/yard/code_objects/base.rb#453
|
2850
2852
|
def to_s; end
|
2851
2853
|
|
2852
2854
|
# Default type is the lowercase class name without the "Object" suffix.
|
@@ -2854,7 +2856,7 @@ class YARD::CodeObjects::Base
|
|
2854
2856
|
#
|
2855
2857
|
# @return [Symbol] the type of code object this represents
|
2856
2858
|
#
|
2857
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2859
|
+
# source://yard//lib/yard/code_objects/base.rb#437
|
2858
2860
|
def type; end
|
2859
2861
|
|
2860
2862
|
# @return [Symbol] the visibility of an object (:public, :private, :protected)
|
@@ -2877,7 +2879,7 @@ class YARD::CodeObjects::Base
|
|
2877
2879
|
# @see #copy_to
|
2878
2880
|
# @since 0.8.0
|
2879
2881
|
#
|
2880
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2882
|
+
# source://yard//lib/yard/code_objects/base.rb#587
|
2881
2883
|
def copyable_attributes; end
|
2882
2884
|
|
2883
2885
|
private
|
@@ -2887,10 +2889,10 @@ class YARD::CodeObjects::Base
|
|
2887
2889
|
# @param source [String] the source code to format
|
2888
2890
|
# @return [String] formatted source
|
2889
2891
|
#
|
2890
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2892
|
+
# source://yard//lib/yard/code_objects/base.rb#599
|
2891
2893
|
def format_source(source); end
|
2892
2894
|
|
2893
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2895
|
+
# source://yard//lib/yard/code_objects/base.rb#606
|
2894
2896
|
def translate_docstring(locale); end
|
2895
2897
|
|
2896
2898
|
class << self
|
@@ -3263,11 +3265,11 @@ YARD::CodeObjects::METHODNAMEMATCH = T.let(T.unsafe(nil), Regexp)
|
|
3263
3265
|
# # Extra data added to docstring
|
3264
3266
|
# property :bar
|
3265
3267
|
#
|
3266
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3268
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#29
|
3267
3269
|
class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
3268
3270
|
# @return [Boolean] whether this macro is attached to a method
|
3269
3271
|
#
|
3270
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3272
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#148
|
3271
3273
|
def attached?; end
|
3272
3274
|
|
3273
3275
|
# Expands the macro using
|
@@ -3282,39 +3284,39 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3282
3284
|
# call, if there is a block.
|
3283
3285
|
# @see expand
|
3284
3286
|
#
|
3285
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3287
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#166
|
3286
3288
|
def expand(call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3287
3289
|
|
3288
3290
|
# @return [String] the macro data stored on the object
|
3289
3291
|
#
|
3290
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3292
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3291
3293
|
def macro_data; end
|
3292
3294
|
|
3293
3295
|
# @return [String] the macro data stored on the object
|
3294
3296
|
#
|
3295
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3297
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3296
3298
|
def macro_data=(_arg0); end
|
3297
3299
|
|
3298
3300
|
# @return [CodeObjects::Base] the method object that this macro is
|
3299
3301
|
# attached to.
|
3300
3302
|
#
|
3301
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3303
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3302
3304
|
def method_object; end
|
3303
3305
|
|
3304
3306
|
# @return [CodeObjects::Base] the method object that this macro is
|
3305
3307
|
# attached to.
|
3306
3308
|
#
|
3307
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3309
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3308
3310
|
def method_object=(_arg0); end
|
3309
3311
|
|
3310
3312
|
# Overrides {Base#path} so the macro path is ".macro.MACRONAME"
|
3311
3313
|
#
|
3312
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3314
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#151
|
3313
3315
|
def path; end
|
3314
3316
|
|
3315
3317
|
# Overrides the separator to be '.'
|
3316
3318
|
#
|
3317
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3319
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#154
|
3318
3320
|
def sep; end
|
3319
3321
|
|
3320
3322
|
class << self
|
@@ -3332,7 +3334,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3332
3334
|
# @return [String] the expanded macro data
|
3333
3335
|
# @see find_or_create
|
3334
3336
|
#
|
3335
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3337
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#119
|
3336
3338
|
def apply(docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil), _method_object = T.unsafe(nil)); end
|
3337
3339
|
|
3338
3340
|
# Applies a macro to a docstring, interpolating the macro's data on the
|
@@ -3348,7 +3350,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3348
3350
|
# interpolating the block data as a variable.
|
3349
3351
|
# @return [String] the expanded macro data
|
3350
3352
|
#
|
3351
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3353
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#135
|
3352
3354
|
def apply_macro(macro, docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3353
3355
|
|
3354
3356
|
# Creates a new macro and fills in the relevant properties.
|
@@ -3359,7 +3361,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3359
3361
|
# macro to. If supplied, {#attached?} will be true
|
3360
3362
|
# @return [MacroObject] the newly created object
|
3361
3363
|
#
|
3362
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3364
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#39
|
3363
3365
|
def create(macro_name, data, method_object = T.unsafe(nil)); end
|
3364
3366
|
|
3365
3367
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3379,7 +3381,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3379
3381
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3380
3382
|
# not new and no macro by the macro name is found.
|
3381
3383
|
#
|
3382
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3384
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3383
3385
|
def create_docstring(macro_name, data, method_object = T.unsafe(nil)); end
|
3384
3386
|
|
3385
3387
|
# Expands +macro_data+ using the interpolation parameters.
|
@@ -3392,7 +3394,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3392
3394
|
#
|
3393
3395
|
# @param macro_data [String] the macro data to expand (taken from {#macro_data})
|
3394
3396
|
#
|
3395
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3397
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#92
|
3396
3398
|
def expand(macro_data, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3397
3399
|
|
3398
3400
|
# Finds a macro using +macro_name+
|
@@ -3401,7 +3403,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3401
3403
|
# @return [MacroObject] if a macro is found
|
3402
3404
|
# @return [nil] if there is no registered macro by that name
|
3403
3405
|
#
|
3404
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3406
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#50
|
3405
3407
|
def find(macro_name); end
|
3406
3408
|
|
3407
3409
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3421,12 +3423,12 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3421
3423
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3422
3424
|
# not new and no macro by the macro name is found.
|
3423
3425
|
#
|
3424
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3426
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3425
3427
|
def find_or_create(macro_name, data, method_object = T.unsafe(nil)); end
|
3426
3428
|
end
|
3427
3429
|
end
|
3428
3430
|
|
3429
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3431
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#30
|
3430
3432
|
YARD::CodeObjects::MacroObject::MACRO_MATCH = T.let(T.unsafe(nil), Regexp)
|
3431
3433
|
|
3432
3434
|
# Represents a Ruby method in source
|
@@ -4761,7 +4763,7 @@ YARD::Docstring::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
|
4761
4763
|
# @see #parse_content
|
4762
4764
|
# @since 0.8.0
|
4763
4765
|
#
|
4764
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4766
|
+
# source://yard//lib/yard/docstring_parser.rb#29
|
4765
4767
|
class YARD::DocstringParser
|
4766
4768
|
# Creates a new parser to parse docstring data
|
4767
4769
|
#
|
@@ -4770,7 +4772,7 @@ class YARD::DocstringParser
|
|
4770
4772
|
# @return [DocstringParser] a new instance of DocstringParser
|
4771
4773
|
# @since 0.8.0
|
4772
4774
|
#
|
4773
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4775
|
+
# source://yard//lib/yard/docstring_parser.rb#80
|
4774
4776
|
def initialize(library = T.unsafe(nil)); end
|
4775
4777
|
|
4776
4778
|
# Creates a new directive using the registered {#library}
|
@@ -4778,14 +4780,14 @@ class YARD::DocstringParser
|
|
4778
4780
|
# @return [Tags::Directive] the directive object that is created
|
4779
4781
|
# @since 0.8.0
|
4780
4782
|
#
|
4781
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4783
|
+
# source://yard//lib/yard/docstring_parser.rb#231
|
4782
4784
|
def create_directive(tag_name, tag_buf); end
|
4783
4785
|
|
4784
4786
|
# Creates a {Tags::RefTag}
|
4785
4787
|
#
|
4786
4788
|
# @since 0.8.0
|
4787
4789
|
#
|
4788
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4790
|
+
# source://yard//lib/yard/docstring_parser.rb#225
|
4789
4791
|
def create_ref_tag(tag_name, name, object_name); end
|
4790
4792
|
|
4791
4793
|
# Creates a tag from the {Tags::DefaultFactory tag factory}.
|
@@ -4797,7 +4799,7 @@ class YARD::DocstringParser
|
|
4797
4799
|
# @return [Tags::Tag, Tags::RefTag] a tag
|
4798
4800
|
# @since 0.8.0
|
4799
4801
|
#
|
4800
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4802
|
+
# source://yard//lib/yard/docstring_parser.rb#208
|
4801
4803
|
def create_tag(tag_name, tag_buf = T.unsafe(nil)); end
|
4802
4804
|
|
4803
4805
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4805,7 +4807,7 @@ class YARD::DocstringParser
|
|
4805
4807
|
# Docstring object.
|
4806
4808
|
# @since 0.8.0
|
4807
4809
|
#
|
4808
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4810
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4809
4811
|
def directives; end
|
4810
4812
|
|
4811
4813
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4813,7 +4815,7 @@ class YARD::DocstringParser
|
|
4813
4815
|
# Docstring object.
|
4814
4816
|
# @since 0.8.0
|
4815
4817
|
#
|
4816
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4818
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4817
4819
|
def directives=(_arg0); end
|
4818
4820
|
|
4819
4821
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4821,7 +4823,7 @@ class YARD::DocstringParser
|
|
4821
4823
|
# initialized through
|
4822
4824
|
# @since 0.8.0
|
4823
4825
|
#
|
4824
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4826
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4825
4827
|
def handler; end
|
4826
4828
|
|
4827
4829
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4829,21 +4831,21 @@ class YARD::DocstringParser
|
|
4829
4831
|
# initialized through
|
4830
4832
|
# @since 0.8.0
|
4831
4833
|
#
|
4832
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4834
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4833
4835
|
def handler=(_arg0); end
|
4834
4836
|
|
4835
4837
|
# @return [Tags::Library] the tag library being used to
|
4836
4838
|
# identify registered tags in the docstring.
|
4837
4839
|
# @since 0.8.0
|
4838
4840
|
#
|
4839
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4841
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4840
4842
|
def library; end
|
4841
4843
|
|
4842
4844
|
# @return [Tags::Library] the tag library being used to
|
4843
4845
|
# identify registered tags in the docstring.
|
4844
4846
|
# @since 0.8.0
|
4845
4847
|
#
|
4846
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4848
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4847
4849
|
def library=(_arg0); end
|
4848
4850
|
|
4849
4851
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4851,7 +4853,7 @@ class YARD::DocstringParser
|
|
4851
4853
|
# not attached to any object.
|
4852
4854
|
# @since 0.8.0
|
4853
4855
|
#
|
4854
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4856
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4855
4857
|
def object; end
|
4856
4858
|
|
4857
4859
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4859,7 +4861,7 @@ class YARD::DocstringParser
|
|
4859
4861
|
# not attached to any object.
|
4860
4862
|
# @since 0.8.0
|
4861
4863
|
#
|
4862
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4864
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4863
4865
|
def object=(_arg0); end
|
4864
4866
|
|
4865
4867
|
# Parses all content and returns itself.
|
@@ -4876,7 +4878,7 @@ class YARD::DocstringParser
|
|
4876
4878
|
# @see #to_docstring
|
4877
4879
|
# @since 0.8.0
|
4878
4880
|
#
|
4879
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4881
|
+
# source://yard//lib/yard/docstring_parser.rb#112
|
4880
4882
|
def parse(content, object = T.unsafe(nil), handler = T.unsafe(nil)); end
|
4881
4883
|
|
4882
4884
|
# Parses a given block of text.
|
@@ -4886,7 +4888,7 @@ class YARD::DocstringParser
|
|
4886
4888
|
# @param content [String] the content to parse
|
4887
4889
|
# @since 0.8.0
|
4888
4890
|
#
|
4889
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4891
|
+
# source://yard//lib/yard/docstring_parser.rb#128
|
4890
4892
|
def parse_content(content); end
|
4891
4893
|
|
4892
4894
|
# Call post processing callbacks on parser.
|
@@ -4896,19 +4898,19 @@ class YARD::DocstringParser
|
|
4896
4898
|
# @return [void]
|
4897
4899
|
# @since 0.8.0
|
4898
4900
|
#
|
4899
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4901
|
+
# source://yard//lib/yard/docstring_parser.rb#195
|
4900
4902
|
def post_process; end
|
4901
4903
|
|
4902
4904
|
# @return [String] the complete input string to the parser.
|
4903
4905
|
# @since 0.8.0
|
4904
4906
|
#
|
4905
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4907
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4906
4908
|
def raw_text; end
|
4907
4909
|
|
4908
4910
|
# @return [String] the complete input string to the parser.
|
4909
4911
|
# @since 0.8.0
|
4910
4912
|
#
|
4911
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4913
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4912
4914
|
def raw_text=(_arg0); end
|
4913
4915
|
|
4914
4916
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4916,7 +4918,7 @@ class YARD::DocstringParser
|
|
4916
4918
|
# refer to any object.
|
4917
4919
|
# @since 0.8.0
|
4918
4920
|
#
|
4919
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4921
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4920
4922
|
def reference; end
|
4921
4923
|
|
4922
4924
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4924,7 +4926,7 @@ class YARD::DocstringParser
|
|
4924
4926
|
# refer to any object.
|
4925
4927
|
# @since 0.8.0
|
4926
4928
|
#
|
4927
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4929
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4928
4930
|
def reference=(_arg0); end
|
4929
4931
|
|
4930
4932
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4933,7 +4935,7 @@ class YARD::DocstringParser
|
|
4933
4935
|
# used in a docstring).
|
4934
4936
|
# @since 0.8.0
|
4935
4937
|
#
|
4936
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4938
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4937
4939
|
def state; end
|
4938
4940
|
|
4939
4941
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4942,7 +4944,7 @@ class YARD::DocstringParser
|
|
4942
4944
|
# used in a docstring).
|
4943
4945
|
# @since 0.8.0
|
4944
4946
|
#
|
4945
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4947
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4946
4948
|
def state=(_arg0); end
|
4947
4949
|
|
4948
4950
|
# Backward compatibility to detect old tags that should be specified
|
@@ -4951,42 +4953,42 @@ class YARD::DocstringParser
|
|
4951
4953
|
# @return [Boolean]
|
4952
4954
|
# @since 0.8.0
|
4953
4955
|
#
|
4954
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4956
|
+
# source://yard//lib/yard/docstring_parser.rb#251
|
4955
4957
|
def tag_is_directive?(tag_name); end
|
4956
4958
|
|
4957
4959
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4958
4960
|
# by the parser
|
4959
4961
|
# @since 0.8.0
|
4960
4962
|
#
|
4961
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4963
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4962
4964
|
def tags; end
|
4963
4965
|
|
4964
4966
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4965
4967
|
# by the parser
|
4966
4968
|
# @since 0.8.0
|
4967
4969
|
#
|
4968
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4970
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4969
4971
|
def tags=(_arg0); end
|
4970
4972
|
|
4971
4973
|
# @return [String] the parsed text portion of the docstring,
|
4972
4974
|
# with tags removed.
|
4973
4975
|
# @since 0.8.0
|
4974
4976
|
#
|
4975
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4977
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4976
4978
|
def text; end
|
4977
4979
|
|
4978
4980
|
# @return [String] the parsed text portion of the docstring,
|
4979
4981
|
# with tags removed.
|
4980
4982
|
# @since 0.8.0
|
4981
4983
|
#
|
4982
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4984
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4983
4985
|
def text=(_arg0); end
|
4984
4986
|
|
4985
4987
|
# @return [Docstring] translates parsed text into
|
4986
4988
|
# a Docstring object.
|
4987
4989
|
# @since 0.8.0
|
4988
4990
|
#
|
4989
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4991
|
+
# source://yard//lib/yard/docstring_parser.rb#94
|
4990
4992
|
def to_docstring; end
|
4991
4993
|
|
4992
4994
|
private
|
@@ -4995,7 +4997,7 @@ class YARD::DocstringParser
|
|
4995
4997
|
#
|
4996
4998
|
# @since 0.8.0
|
4997
4999
|
#
|
4998
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5000
|
+
# source://yard//lib/yard/docstring_parser.rb#323
|
4999
5001
|
def call_after_parse_callbacks; end
|
5000
5002
|
|
5001
5003
|
# Calls the {Tags::Directive#after_parse} callback on all the
|
@@ -5003,17 +5005,17 @@ class YARD::DocstringParser
|
|
5003
5005
|
#
|
5004
5006
|
# @since 0.8.0
|
5005
5007
|
#
|
5006
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5008
|
+
# source://yard//lib/yard/docstring_parser.rb#318
|
5007
5009
|
def call_directives_after_parse; end
|
5008
5010
|
|
5009
5011
|
# @since 0.8.0
|
5010
5012
|
#
|
5011
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5013
|
+
# source://yard//lib/yard/docstring_parser.rb#304
|
5012
5014
|
def detect_reference(content); end
|
5013
5015
|
|
5014
5016
|
# @since 0.8.0
|
5015
5017
|
#
|
5016
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5018
|
+
# source://yard//lib/yard/docstring_parser.rb#300
|
5017
5019
|
def namespace; end
|
5018
5020
|
|
5019
5021
|
class << self
|
@@ -5028,13 +5030,13 @@ class YARD::DocstringParser
|
|
5028
5030
|
# with all directives and tags created.
|
5029
5031
|
# @yieldreturn [void]
|
5030
5032
|
#
|
5031
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5033
|
+
# source://yard//lib/yard/docstring_parser.rb#265
|
5032
5034
|
def after_parse(&block); end
|
5033
5035
|
|
5034
5036
|
# @return [Array<Proc>] the {after_parse} callback proc objects
|
5035
5037
|
# @since 0.8.0
|
5036
5038
|
#
|
5037
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5039
|
+
# source://yard//lib/yard/docstring_parser.rb#270
|
5038
5040
|
def after_parse_callbacks; end
|
5039
5041
|
end
|
5040
5042
|
end
|
@@ -5043,7 +5045,7 @@ end
|
|
5043
5045
|
#
|
5044
5046
|
# @since 0.8.0
|
5045
5047
|
#
|
5046
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5048
|
+
# source://yard//lib/yard/docstring_parser.rb#72
|
5047
5049
|
YARD::DocstringParser::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
5048
5050
|
|
5049
5051
|
# source://yard//lib/yard/gem_index.rb#6
|
@@ -5952,14 +5954,14 @@ end
|
|
5952
5954
|
#
|
5953
5955
|
# @see Handlers::Base
|
5954
5956
|
#
|
5955
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5957
|
+
# source://yard//lib/yard/handlers/processor.rb#19
|
5956
5958
|
class YARD::Handlers::Processor
|
5957
5959
|
# Creates a new Processor for a +file+.
|
5958
5960
|
#
|
5959
5961
|
# @param parser [Parser::SourceParser] the parser used to initialize the processor
|
5960
5962
|
# @return [Processor] a new instance of Processor
|
5961
5963
|
#
|
5962
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5964
|
+
# source://yard//lib/yard/handlers/processor.rb#91
|
5963
5965
|
def initialize(parser); end
|
5964
5966
|
|
5965
5967
|
# Share state across different handlers inside of a file.
|
@@ -5972,7 +5974,7 @@ class YARD::Handlers::Processor
|
|
5972
5974
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5973
5975
|
# @see #globals
|
5974
5976
|
#
|
5975
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5977
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5976
5978
|
def extra_state; end
|
5977
5979
|
|
5978
5980
|
# Share state across different handlers inside of a file.
|
@@ -5985,17 +5987,17 @@ class YARD::Handlers::Processor
|
|
5985
5987
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5986
5988
|
# @see #globals
|
5987
5989
|
#
|
5988
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5990
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5989
5991
|
def extra_state=(_arg0); end
|
5990
5992
|
|
5991
5993
|
# @return [String] the filename
|
5992
5994
|
#
|
5993
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5995
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
5994
5996
|
def file; end
|
5995
5997
|
|
5996
5998
|
# @return [String] the filename
|
5997
5999
|
#
|
5998
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6000
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
5999
6001
|
def file=(_arg0); end
|
6000
6002
|
|
6001
6003
|
# Searches for all handlers in {Base.subclasses} that match the +statement+
|
@@ -6003,7 +6005,7 @@ class YARD::Handlers::Processor
|
|
6003
6005
|
# @param statement the statement object to match.
|
6004
6006
|
# @return [Array<Base>] a list of handlers to process the statement with.
|
6005
6007
|
#
|
6006
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6008
|
+
# source://yard//lib/yard/handlers/processor.rb#150
|
6007
6009
|
def find_handlers(statement); end
|
6008
6010
|
|
6009
6011
|
# Handlers can share state for the entire post processing stage through
|
@@ -6023,7 +6025,7 @@ class YARD::Handlers::Processor
|
|
6023
6025
|
# @return [OpenStruct] global shared state for post-processing stage
|
6024
6026
|
# @see #extra_state
|
6025
6027
|
#
|
6026
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6028
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6027
6029
|
def globals; end
|
6028
6030
|
|
6029
6031
|
# Handlers can share state for the entire post processing stage through
|
@@ -6043,17 +6045,17 @@ class YARD::Handlers::Processor
|
|
6043
6045
|
# @return [OpenStruct] global shared state for post-processing stage
|
6044
6046
|
# @see #extra_state
|
6045
6047
|
#
|
6046
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6048
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6047
6049
|
def globals=(_arg0); end
|
6048
6050
|
|
6049
6051
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6050
6052
|
#
|
6051
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6053
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6052
6054
|
def namespace; end
|
6053
6055
|
|
6054
6056
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6055
6057
|
#
|
6056
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6058
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6057
6059
|
def namespace=(_arg0); end
|
6058
6060
|
|
6059
6061
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6061,7 +6063,7 @@ class YARD::Handlers::Processor
|
|
6061
6063
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6062
6064
|
# is set as the owner, in case any extra method information is processed.
|
6063
6065
|
#
|
6064
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6066
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6065
6067
|
def owner; end
|
6066
6068
|
|
6067
6069
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6069,7 +6071,7 @@ class YARD::Handlers::Processor
|
|
6069
6071
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6070
6072
|
# is set as the owner, in case any extra method information is processed.
|
6071
6073
|
#
|
6072
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6074
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6073
6075
|
def owner=(_arg0); end
|
6074
6076
|
|
6075
6077
|
# Continue parsing the remainder of the files in the +globals.ordered_parser+
|
@@ -6079,17 +6081,17 @@ class YARD::Handlers::Processor
|
|
6079
6081
|
# @return [void]
|
6080
6082
|
# @see Parser::OrderedParser
|
6081
6083
|
#
|
6082
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6084
|
+
# source://yard//lib/yard/handlers/processor.rb#139
|
6083
6085
|
def parse_remaining_files; end
|
6084
6086
|
|
6085
6087
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6086
6088
|
#
|
6087
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6089
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6088
6090
|
def parser_type; end
|
6089
6091
|
|
6090
6092
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6091
6093
|
#
|
6092
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6094
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6093
6095
|
def parser_type=(_arg0); end
|
6094
6096
|
|
6095
6097
|
# Processes a list of statements by finding handlers to process each
|
@@ -6098,27 +6100,27 @@ class YARD::Handlers::Processor
|
|
6098
6100
|
# @param statements [Array] a list of statements
|
6099
6101
|
# @return [void]
|
6100
6102
|
#
|
6101
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6103
|
+
# source://yard//lib/yard/handlers/processor.rb#109
|
6102
6104
|
def process(statements); end
|
6103
6105
|
|
6104
6106
|
# @return [Symbol] the current scope (class, instance)
|
6105
6107
|
#
|
6106
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6108
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6107
6109
|
def scope; end
|
6108
6110
|
|
6109
6111
|
# @return [Symbol] the current scope (class, instance)
|
6110
6112
|
#
|
6111
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6113
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6112
6114
|
def scope=(_arg0); end
|
6113
6115
|
|
6114
6116
|
# @return [Symbol] the current visibility (public, private, protected)
|
6115
6117
|
#
|
6116
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6118
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6117
6119
|
def visibility; end
|
6118
6120
|
|
6119
6121
|
# @return [Symbol] the current visibility (public, private, protected)
|
6120
6122
|
#
|
6121
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6123
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6122
6124
|
def visibility=(_arg0); end
|
6123
6125
|
|
6124
6126
|
private
|
@@ -6127,7 +6129,7 @@ class YARD::Handlers::Processor
|
|
6127
6129
|
#
|
6128
6130
|
# @return [Base] the base class
|
6129
6131
|
#
|
6130
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6132
|
+
# source://yard//lib/yard/handlers/processor.rb#171
|
6131
6133
|
def handler_base_class; end
|
6132
6134
|
|
6133
6135
|
# The module holding the handlers to be loaded
|
@@ -6135,12 +6137,12 @@ class YARD::Handlers::Processor
|
|
6135
6137
|
# @return [Module] the module containing the handlers depending on
|
6136
6138
|
# {#parser_type}.
|
6137
6139
|
#
|
6138
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6140
|
+
# source://yard//lib/yard/handlers/processor.rb#179
|
6139
6141
|
def handler_base_namespace; end
|
6140
6142
|
|
6141
6143
|
# @return [Boolean]
|
6142
6144
|
#
|
6143
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6145
|
+
# source://yard//lib/yard/handlers/processor.rb#160
|
6144
6146
|
def handles?(handler, statement); end
|
6145
6147
|
|
6146
6148
|
# Loads handlers from {#handler_base_namespace}. This ensures that
|
@@ -6149,7 +6151,7 @@ class YARD::Handlers::Processor
|
|
6149
6151
|
#
|
6150
6152
|
# @return [void]
|
6151
6153
|
#
|
6152
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6154
|
+
# source://yard//lib/yard/handlers/processor.rb#187
|
6153
6155
|
def load_handlers; end
|
6154
6156
|
|
6155
6157
|
class << self
|
@@ -6157,14 +6159,14 @@ class YARD::Handlers::Processor
|
|
6157
6159
|
# @return [Hash] a list of registered parser type extensions
|
6158
6160
|
# @since 0.6.0
|
6159
6161
|
#
|
6160
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6162
|
+
# source://yard//lib/yard/handlers/processor.rb#32
|
6161
6163
|
def namespace_for_handler; end
|
6162
6164
|
|
6163
6165
|
# Registers a new namespace for handlers of the given type.
|
6164
6166
|
#
|
6165
6167
|
# @since 0.6.0
|
6166
6168
|
#
|
6167
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6169
|
+
# source://yard//lib/yard/handlers/processor.rb#23
|
6168
6170
|
def register_handler_namespace(type, ns); end
|
6169
6171
|
end
|
6170
6172
|
end
|
@@ -6997,6 +6999,11 @@ end
|
|
6997
6999
|
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#3
|
6998
7000
|
class YARD::Handlers::Ruby::VisibilityHandler < ::YARD::Handlers::Ruby::Base
|
6999
7001
|
include ::YARD::Handlers::Ruby::DecoratorHandlerMethods
|
7002
|
+
|
7003
|
+
# @return [Boolean]
|
7004
|
+
#
|
7005
|
+
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#31
|
7006
|
+
def is_attribute_method?(node); end
|
7000
7007
|
end
|
7001
7008
|
|
7002
7009
|
# Handles 'yield' calls
|
@@ -7459,13 +7466,16 @@ end
|
|
7459
7466
|
# Handles console logging for info, warnings and errors.
|
7460
7467
|
# Uses the stdlib Logger class in Ruby for all the backend logic.
|
7461
7468
|
#
|
7462
|
-
# source://yard//lib/yard/logging.rb#
|
7463
|
-
class YARD::Logger
|
7469
|
+
# source://yard//lib/yard/logging.rb#8
|
7470
|
+
class YARD::Logger
|
7471
|
+
include ::YARD::Logger::Severity
|
7472
|
+
|
7464
7473
|
# Creates a new logger
|
7465
7474
|
#
|
7475
|
+
# @private
|
7466
7476
|
# @return [Logger] a new instance of Logger
|
7467
7477
|
#
|
7468
|
-
# source://yard//lib/yard/logging.rb#
|
7478
|
+
# source://yard//lib/yard/logging.rb#82
|
7469
7479
|
def initialize(pipe, *args); end
|
7470
7480
|
|
7471
7481
|
# Displays an unformatted line to the logger output stream.
|
@@ -7474,7 +7484,7 @@ class YARD::Logger < ::Logger
|
|
7474
7484
|
# @return [void]
|
7475
7485
|
# @since 0.8.2
|
7476
7486
|
#
|
7477
|
-
# source://yard//lib/yard/logging.rb#
|
7487
|
+
# source://yard//lib/yard/logging.rb#205
|
7478
7488
|
def <<(msg = T.unsafe(nil)); end
|
7479
7489
|
|
7480
7490
|
# Prints the backtrace +exc+ to the logger as error data.
|
@@ -7483,7 +7493,7 @@ class YARD::Logger < ::Logger
|
|
7483
7493
|
# @param level_meth [Symbol] the level to log backtrace at
|
7484
7494
|
# @return [void]
|
7485
7495
|
#
|
7486
|
-
# source://yard//lib/yard/logging.rb#
|
7496
|
+
# source://yard//lib/yard/logging.rb#216
|
7487
7497
|
def backtrace(exc, level_meth = T.unsafe(nil)); end
|
7488
7498
|
|
7489
7499
|
# Captures the duration of a block of code for benchmark analysis. Also
|
@@ -7496,7 +7506,7 @@ class YARD::Logger < ::Logger
|
|
7496
7506
|
# @todo Implement capture storage for reporting of benchmarks
|
7497
7507
|
# @yield a block of arbitrary code to benchmark
|
7498
7508
|
#
|
7499
|
-
# source://yard//lib/yard/logging.rb#
|
7509
|
+
# source://yard//lib/yard/logging.rb#234
|
7500
7510
|
def capture(msg, nontty_log = T.unsafe(nil)); end
|
7501
7511
|
|
7502
7512
|
# Clears the progress indicator in the TTY display.
|
@@ -7504,14 +7514,18 @@ class YARD::Logger < ::Logger
|
|
7504
7514
|
# @return [void]
|
7505
7515
|
# @since 0.8.2
|
7506
7516
|
#
|
7507
|
-
# source://yard//lib/yard/logging.rb#
|
7517
|
+
# source://yard//lib/yard/logging.rb#186
|
7508
7518
|
def clear_progress; end
|
7509
7519
|
|
7510
|
-
# Changes the debug level to DEBUG if $DEBUG is set
|
7511
|
-
#
|
7520
|
+
# Changes the debug level to DEBUG if $DEBUG is set and writes a debugging message.
|
7521
|
+
# Logs a message with the debug severity level.
|
7522
|
+
#
|
7523
|
+
# @param message [String] the message to log
|
7524
|
+
# @return [void]
|
7525
|
+
# @see #log
|
7512
7526
|
#
|
7513
|
-
# source://yard//lib/yard/logging.rb#
|
7514
|
-
def debug(
|
7527
|
+
# source://yard//lib/yard/logging.rb#103
|
7528
|
+
def debug(message); end
|
7515
7529
|
|
7516
7530
|
# Sets the logger level for the duration of the block
|
7517
7531
|
#
|
@@ -7523,17 +7537,65 @@ class YARD::Logger < ::Logger
|
|
7523
7537
|
# values can be found in Ruby's Logger class.
|
7524
7538
|
# @yield the block with the logger temporarily set to +new_level+
|
7525
7539
|
#
|
7526
|
-
# source://yard//lib/yard/logging.rb#
|
7540
|
+
# source://yard//lib/yard/logging.rb#142
|
7527
7541
|
def enter_level(new_level = T.unsafe(nil)); end
|
7528
7542
|
|
7543
|
+
# Logs a message with the error severity level.
|
7544
|
+
#
|
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 error(message); end
|
7551
|
+
|
7552
|
+
# Logs a message with the fatal severity level.
|
7553
|
+
#
|
7554
|
+
# @param message [String] the message to log
|
7555
|
+
# @return [void]
|
7556
|
+
# @see #log
|
7557
|
+
#
|
7558
|
+
# source://yard//lib/yard/logging.rb#103
|
7559
|
+
def fatal(message); end
|
7560
|
+
|
7561
|
+
# Logs a message with the info severity level.
|
7562
|
+
#
|
7563
|
+
# @param message [String] the message to log
|
7564
|
+
# @return [void]
|
7565
|
+
# @see #log
|
7566
|
+
#
|
7567
|
+
# source://yard//lib/yard/logging.rb#103
|
7568
|
+
def info(message); end
|
7569
|
+
|
7529
7570
|
# @return [IO] the IO object being logged to
|
7530
7571
|
# @since 0.8.2
|
7531
7572
|
#
|
7532
|
-
# source://yard//lib/yard/logging.rb#
|
7573
|
+
# source://yard//lib/yard/logging.rb#49
|
7533
7574
|
def io; end
|
7534
7575
|
|
7535
|
-
#
|
7536
|
-
|
7576
|
+
# @return [IO] the IO object being logged to
|
7577
|
+
# @since 0.8.2
|
7578
|
+
#
|
7579
|
+
# source://yard//lib/yard/logging.rb#49
|
7580
|
+
def io=(_arg0); end
|
7581
|
+
|
7582
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7583
|
+
#
|
7584
|
+
# source://yard//lib/yard/logging.rb#57
|
7585
|
+
def level; end
|
7586
|
+
|
7587
|
+
# @return [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the logging level
|
7588
|
+
#
|
7589
|
+
# source://yard//lib/yard/logging.rb#57
|
7590
|
+
def level=(_arg0); end
|
7591
|
+
|
7592
|
+
# Logs a message with a given severity
|
7593
|
+
#
|
7594
|
+
# @param severity [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN] the severity level
|
7595
|
+
# @param message [String] the message to log
|
7596
|
+
#
|
7597
|
+
# source://yard//lib/yard/logging.rb#122
|
7598
|
+
def log(severity, message); end
|
7537
7599
|
|
7538
7600
|
# Displays an unformatted line to the logger output stream.
|
7539
7601
|
#
|
@@ -7541,7 +7603,7 @@ class YARD::Logger < ::Logger
|
|
7541
7603
|
# @return [void]
|
7542
7604
|
# @since 0.8.2
|
7543
7605
|
#
|
7544
|
-
# source://yard//lib/yard/logging.rb#
|
7606
|
+
# source://yard//lib/yard/logging.rb#205
|
7545
7607
|
def print(msg = T.unsafe(nil)); end
|
7546
7608
|
|
7547
7609
|
# Displays a progress indicator for a given message. This progress report
|
@@ -7554,7 +7616,7 @@ class YARD::Logger < ::Logger
|
|
7554
7616
|
# @return [void]
|
7555
7617
|
# @since 0.8.2
|
7556
7618
|
#
|
7557
|
-
# source://yard//lib/yard/logging.rb#
|
7619
|
+
# source://yard//lib/yard/logging.rb#161
|
7558
7620
|
def progress(msg, nontty_log = T.unsafe(nil)); end
|
7559
7621
|
|
7560
7622
|
# Displays an unformatted line to the logger output stream, adding
|
@@ -7564,86 +7626,91 @@ class YARD::Logger < ::Logger
|
|
7564
7626
|
# @return [void]
|
7565
7627
|
# @since 0.8.2
|
7566
7628
|
#
|
7567
|
-
# source://yard//lib/yard/logging.rb#
|
7629
|
+
# source://yard//lib/yard/logging.rb#197
|
7568
7630
|
def puts(msg = T.unsafe(nil)); end
|
7569
7631
|
|
7570
7632
|
# @return [Boolean] whether backtraces should be shown (by default
|
7571
7633
|
# this is on).
|
7572
7634
|
#
|
7573
|
-
# source://yard//lib/yard/logging.rb#
|
7635
|
+
# source://yard//lib/yard/logging.rb#53
|
7574
7636
|
def show_backtraces; end
|
7575
7637
|
|
7576
7638
|
# Sets the attribute show_backtraces
|
7577
7639
|
#
|
7578
7640
|
# @param value the value to set the attribute show_backtraces to.
|
7579
7641
|
#
|
7580
|
-
# source://yard//lib/yard/logging.rb#
|
7642
|
+
# source://yard//lib/yard/logging.rb#54
|
7581
7643
|
def show_backtraces=(_arg0); end
|
7582
7644
|
|
7583
7645
|
# @return [Boolean] whether progress indicators should be shown when
|
7584
7646
|
# logging CLIs (by default this is off).
|
7585
7647
|
#
|
7586
|
-
# source://yard//lib/yard/logging.rb#
|
7648
|
+
# source://yard//lib/yard/logging.rb#64
|
7587
7649
|
def show_progress; end
|
7588
7650
|
|
7589
7651
|
# Sets the attribute show_progress
|
7590
7652
|
#
|
7591
7653
|
# @param value the value to set the attribute show_progress to.
|
7592
7654
|
#
|
7593
|
-
# source://yard//lib/yard/logging.rb#
|
7655
|
+
# source://yard//lib/yard/logging.rb#70
|
7594
7656
|
def show_progress=(_arg0); end
|
7595
7657
|
|
7658
|
+
# Logs a message with the unknown severity level.
|
7659
|
+
#
|
7660
|
+
# @param message [String] the message to log
|
7661
|
+
# @return [void]
|
7662
|
+
# @see #log
|
7663
|
+
#
|
7664
|
+
# source://yard//lib/yard/logging.rb#103
|
7665
|
+
def unknown(message); end
|
7666
|
+
|
7596
7667
|
# Remembers when a warning occurs and writes a warning message.
|
7668
|
+
# Logs a message with the warn severity level.
|
7597
7669
|
#
|
7598
|
-
#
|
7599
|
-
|
7670
|
+
# @param message [String] the message to log
|
7671
|
+
# @return [void]
|
7672
|
+
# @see #log
|
7673
|
+
#
|
7674
|
+
# source://yard//lib/yard/logging.rb#103
|
7675
|
+
def warn(message); end
|
7600
7676
|
|
7601
7677
|
# Warns that the Ruby environment does not support continuations. Applies
|
7602
7678
|
# to JRuby, Rubinius and MacRuby. This warning will only display once
|
7603
7679
|
# per Ruby process.
|
7604
7680
|
#
|
7605
7681
|
# @deprecated Continuations are no longer needed by YARD 0.8.0+.
|
7682
|
+
# @private
|
7606
7683
|
# @return [void]
|
7607
7684
|
#
|
7608
|
-
# source://yard//lib/yard/logging.rb#
|
7685
|
+
# source://yard//lib/yard/logging.rb#250
|
7609
7686
|
def warn_no_continuations; end
|
7610
7687
|
|
7611
|
-
#
|
7688
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7612
7689
|
#
|
7613
|
-
# source://yard//lib/yard/logging.rb#
|
7690
|
+
# source://yard//lib/yard/logging.rb#60
|
7614
7691
|
def warned; end
|
7615
7692
|
|
7616
|
-
#
|
7693
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7617
7694
|
#
|
7618
|
-
#
|
7619
|
-
#
|
7620
|
-
# source://yard//lib/yard/logging.rb#69
|
7695
|
+
# source://yard//lib/yard/logging.rb#60
|
7621
7696
|
def warned=(_arg0); end
|
7622
7697
|
|
7623
7698
|
private
|
7624
7699
|
|
7625
|
-
#
|
7626
|
-
#
|
7627
|
-
# source://yard//lib/yard/logging.rb#190
|
7628
|
-
def add(*args); end
|
7629
|
-
|
7630
|
-
# source://yard//lib/yard/logging.rb#195
|
7700
|
+
# source://yard//lib/yard/logging.rb#255
|
7631
7701
|
def clear_line; end
|
7632
7702
|
|
7633
|
-
# Log format (from Logger implementation). Used by Logger internally
|
7634
|
-
#
|
7635
|
-
# source://yard//lib/yard/logging.rb#201
|
7636
|
-
def format_log(sev, _time, _prog, msg); end
|
7637
|
-
|
7638
|
-
# source://logger/1.6.0/logger.rb#684
|
7639
|
-
def print_no_newline(msg); end
|
7640
|
-
|
7641
7703
|
class << self
|
7704
|
+
# @private
|
7705
|
+
#
|
7706
|
+
# source://yard//lib/yard/logging.rb#101
|
7707
|
+
def create_log_method(name); end
|
7708
|
+
|
7642
7709
|
# The logger instance
|
7643
7710
|
#
|
7644
7711
|
# @return [Logger] the logger instance
|
7645
7712
|
#
|
7646
|
-
# source://yard//lib/yard/logging.rb#
|
7713
|
+
# source://yard//lib/yard/logging.rb#76
|
7647
7714
|
def instance(pipe = T.unsafe(nil)); end
|
7648
7715
|
end
|
7649
7716
|
end
|
@@ -7653,9 +7720,97 @@ end
|
|
7653
7720
|
#
|
7654
7721
|
# @since 0.8.2
|
7655
7722
|
#
|
7656
|
-
# source://yard//lib/yard/logging.rb#
|
7723
|
+
# source://yard//lib/yard/logging.rb#45
|
7657
7724
|
YARD::Logger::PROGRESS_INDICATORS = T.let(T.unsafe(nil), Array)
|
7658
7725
|
|
7726
|
+
# Log severity levels
|
7727
|
+
#
|
7728
|
+
# source://yard//lib/yard/logging.rb#10
|
7729
|
+
module YARD::Logger::Severity; end
|
7730
|
+
|
7731
|
+
# Debugging log level
|
7732
|
+
#
|
7733
|
+
# source://yard//lib/yard/logging.rb#12
|
7734
|
+
YARD::Logger::Severity::DEBUG = T.let(T.unsafe(nil), Integer)
|
7735
|
+
|
7736
|
+
# Error log level
|
7737
|
+
#
|
7738
|
+
# source://yard//lib/yard/logging.rb#21
|
7739
|
+
YARD::Logger::Severity::ERROR = T.let(T.unsafe(nil), Integer)
|
7740
|
+
|
7741
|
+
# Fatal log level
|
7742
|
+
#
|
7743
|
+
# source://yard//lib/yard/logging.rb#24
|
7744
|
+
YARD::Logger::Severity::FATAL = T.let(T.unsafe(nil), Integer)
|
7745
|
+
|
7746
|
+
# Information log level
|
7747
|
+
#
|
7748
|
+
# source://yard//lib/yard/logging.rb#15
|
7749
|
+
YARD::Logger::Severity::INFO = T.let(T.unsafe(nil), Integer)
|
7750
|
+
|
7751
|
+
# @private
|
7752
|
+
#
|
7753
|
+
# source://yard//lib/yard/logging.rb#30
|
7754
|
+
YARD::Logger::Severity::SEVERITIES = T.let(T.unsafe(nil), Hash)
|
7755
|
+
|
7756
|
+
# Unknown log level
|
7757
|
+
#
|
7758
|
+
# source://yard//lib/yard/logging.rb#27
|
7759
|
+
YARD::Logger::Severity::UNKNOWN = T.let(T.unsafe(nil), Integer)
|
7760
|
+
|
7761
|
+
# Warning log level
|
7762
|
+
#
|
7763
|
+
# source://yard//lib/yard/logging.rb#18
|
7764
|
+
YARD::Logger::Severity::WARN = T.let(T.unsafe(nil), Integer)
|
7765
|
+
|
7766
|
+
# An OpenStruct compatible struct class that allows for basic access of attributes
|
7767
|
+
# via +struct.attr_name+ and +struct.attr_name = value+.
|
7768
|
+
#
|
7769
|
+
# source://yard//lib/yard/open_struct.rb#4
|
7770
|
+
class YARD::OpenStruct
|
7771
|
+
# @return [OpenStruct] a new instance of OpenStruct
|
7772
|
+
#
|
7773
|
+
# source://yard//lib/yard/open_struct.rb#5
|
7774
|
+
def initialize(hash = T.unsafe(nil)); end
|
7775
|
+
|
7776
|
+
# source://yard//lib/yard/open_struct.rb#25
|
7777
|
+
def ==(other); end
|
7778
|
+
|
7779
|
+
# source://yard//lib/yard/open_struct.rb#41
|
7780
|
+
def [](key); end
|
7781
|
+
|
7782
|
+
# source://yard//lib/yard/open_struct.rb#37
|
7783
|
+
def []=(key, value); end
|
7784
|
+
|
7785
|
+
# source://yard//lib/yard/open_struct.rb#33
|
7786
|
+
def dig(*keys); end
|
7787
|
+
|
7788
|
+
# source://yard//lib/yard/open_struct.rb#45
|
7789
|
+
def each_pair(&block); end
|
7790
|
+
|
7791
|
+
# source://yard//lib/yard/open_struct.rb#29
|
7792
|
+
def hash; end
|
7793
|
+
|
7794
|
+
# source://yard//lib/yard/open_struct.rb#49
|
7795
|
+
def marshal_dump; end
|
7796
|
+
|
7797
|
+
# source://yard//lib/yard/open_struct.rb#53
|
7798
|
+
def marshal_load(data); end
|
7799
|
+
|
7800
|
+
# @private
|
7801
|
+
#
|
7802
|
+
# source://yard//lib/yard/open_struct.rb#10
|
7803
|
+
def method_missing(name, *args); end
|
7804
|
+
|
7805
|
+
# source://yard//lib/yard/open_struct.rb#21
|
7806
|
+
def to_h; end
|
7807
|
+
|
7808
|
+
private
|
7809
|
+
|
7810
|
+
# source://yard//lib/yard/open_struct.rb#59
|
7811
|
+
def __cache_lookup__(name); end
|
7812
|
+
end
|
7813
|
+
|
7659
7814
|
# Generalized options class for passing around large amounts of options between objects.
|
7660
7815
|
#
|
7661
7816
|
# The options class exists for better visibility and documentability of options being
|
@@ -8207,7 +8362,7 @@ end
|
|
8207
8362
|
#
|
8208
8363
|
# @see Processor#parse_remaining_files
|
8209
8364
|
#
|
8210
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8365
|
+
# source://yard//lib/yard/parser/source_parser.rb#20
|
8211
8366
|
class YARD::Parser::OrderedParser
|
8212
8367
|
# Creates a new OrderedParser with the global state and a list
|
8213
8368
|
# of files to parse.
|
@@ -8219,30 +8374,30 @@ class YARD::Parser::OrderedParser
|
|
8219
8374
|
# @param files [Array<String>] the list of files to parse
|
8220
8375
|
# @return [OrderedParser] a new instance of OrderedParser
|
8221
8376
|
#
|
8222
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8377
|
+
# source://yard//lib/yard/parser/source_parser.rb#32
|
8223
8378
|
def initialize(global_state, files); end
|
8224
8379
|
|
8225
8380
|
# @return [Array<String>] the list of remaining files to parse
|
8226
8381
|
#
|
8227
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8382
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8228
8383
|
def files; end
|
8229
8384
|
|
8230
8385
|
# @return [Array<String>] the list of remaining files to parse
|
8231
8386
|
#
|
8232
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8387
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8233
8388
|
def files=(_arg0); end
|
8234
8389
|
|
8235
8390
|
# Parses the remainder of the {#files} list.
|
8236
8391
|
#
|
8237
8392
|
# @see Processor#parse_remaining_files
|
8238
8393
|
#
|
8239
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8394
|
+
# source://yard//lib/yard/parser/source_parser.rb#41
|
8240
8395
|
def parse; end
|
8241
8396
|
end
|
8242
8397
|
|
8243
8398
|
# Raised when the parser sees a Ruby syntax error
|
8244
8399
|
#
|
8245
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8400
|
+
# source://yard//lib/yard/parser/source_parser.rb#12
|
8246
8401
|
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
|
8247
8402
|
|
8248
8403
|
# Ruby parsing components.
|
@@ -8687,6 +8842,9 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8687
8842
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#430
|
8688
8843
|
def continue; end
|
8689
8844
|
|
8845
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1116
|
8846
|
+
def dedent(str); end
|
8847
|
+
|
8690
8848
|
# Returns the value of attribute exception_on_syntax_error.
|
8691
8849
|
#
|
8692
8850
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#463
|
@@ -8711,7 +8869,7 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8711
8869
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#488
|
8712
8870
|
def gets; end
|
8713
8871
|
|
8714
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8872
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1272
|
8715
8873
|
def identify_comment; end
|
8716
8874
|
|
8717
8875
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#945
|
@@ -8723,13 +8881,13 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8723
8881
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#980
|
8724
8882
|
def identify_identifier; end
|
8725
8883
|
|
8726
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8884
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1145
|
8727
8885
|
def identify_number(start); end
|
8728
8886
|
|
8729
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8887
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1126
|
8730
8888
|
def identify_quotation(initial_char); end
|
8731
8889
|
|
8732
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8890
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1207
|
8733
8891
|
def identify_string(ltype, quoted = T.unsafe(nil), opener = T.unsafe(nil), initial_char = T.unsafe(nil)); end
|
8734
8892
|
|
8735
8893
|
# Returns the value of attribute indent.
|
@@ -8776,10 +8934,10 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8776
8934
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#462
|
8777
8935
|
def read_auto_clean_up=(_arg0); end
|
8778
8936
|
|
8779
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8937
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1295
|
8780
8938
|
def read_escape; end
|
8781
8939
|
|
8782
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8940
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1257
|
8783
8941
|
def skip_inner_expression; end
|
8784
8942
|
|
8785
8943
|
# Returns the value of attribute skip_space.
|
@@ -10968,7 +11126,7 @@ end
|
|
10968
11126
|
# @see Handlers::Base
|
10969
11127
|
# @see CodeObjects::Base
|
10970
11128
|
#
|
10971
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11129
|
+
# source://yard//lib/yard/parser/source_parser.rb#63
|
10972
11130
|
class YARD::Parser::SourceParser
|
10973
11131
|
# @overload initialize
|
10974
11132
|
# @return [SourceParser] a new instance of SourceParser
|
@@ -11033,10 +11191,10 @@ class YARD::Parser::SourceParser
|
|
11033
11191
|
|
11034
11192
|
# @since 0.5.6
|
11035
11193
|
#
|
11036
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11194
|
+
# source://yard//lib/yard/parser/source_parser.rb#515
|
11037
11195
|
def parser_class; end
|
11038
11196
|
|
11039
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11197
|
+
# source://yard//lib/yard/parser/source_parser.rb#500
|
11040
11198
|
def parser_type=(value); end
|
11041
11199
|
|
11042
11200
|
# Guesses the parser type to use depending on the file extension.
|
@@ -11044,14 +11202,14 @@ class YARD::Parser::SourceParser
|
|
11044
11202
|
# @param filename [String] the filename to use to guess the parser type
|
11045
11203
|
# @return [Symbol] a parser type that matches the filename
|
11046
11204
|
#
|
11047
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11205
|
+
# source://yard//lib/yard/parser/source_parser.rb#508
|
11048
11206
|
def parser_type_for_filename(filename); end
|
11049
11207
|
|
11050
11208
|
# Runs a {Handlers::Processor} object to post process the parsed statements.
|
11051
11209
|
#
|
11052
11210
|
# @return [void]
|
11053
11211
|
#
|
11054
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11212
|
+
# source://yard//lib/yard/parser/source_parser.rb#490
|
11055
11213
|
def post_process; end
|
11056
11214
|
|
11057
11215
|
class << self
|
@@ -11224,7 +11382,7 @@ class YARD::Parser::SourceParser
|
|
11224
11382
|
# {YARD::Logger}
|
11225
11383
|
# @return [void]
|
11226
11384
|
#
|
11227
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11385
|
+
# source://yard//lib/yard/parser/source_parser.rb#99
|
11228
11386
|
def parse(paths = T.unsafe(nil), excluded = T.unsafe(nil), level = T.unsafe(nil)); end
|
11229
11387
|
|
11230
11388
|
# Parses a string +content+
|
@@ -11238,10 +11396,10 @@ class YARD::Parser::SourceParser
|
|
11238
11396
|
|
11239
11397
|
# @return [Symbol] the default parser type (defaults to :ruby)
|
11240
11398
|
#
|
11241
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11399
|
+
# source://yard//lib/yard/parser/source_parser.rb#85
|
11242
11400
|
def parser_type; end
|
11243
11401
|
|
11244
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11402
|
+
# source://yard//lib/yard/parser/source_parser.rb#87
|
11245
11403
|
def parser_type=(value); end
|
11246
11404
|
|
11247
11405
|
# @private
|
@@ -11322,30 +11480,30 @@ end
|
|
11322
11480
|
#
|
11323
11481
|
# @since 0.9.0
|
11324
11482
|
#
|
11325
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11483
|
+
# source://yard//lib/yard/parser/source_parser.rb#70
|
11326
11484
|
YARD::Parser::SourceParser::DEFAULT_PATH_GLOB = T.let(T.unsafe(nil), Array)
|
11327
11485
|
|
11328
11486
|
# Byte order marks for various encodings
|
11329
11487
|
#
|
11330
11488
|
# @since 0.7.0
|
11331
11489
|
#
|
11332
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11490
|
+
# source://yard//lib/yard/parser/source_parser.rb#74
|
11333
11491
|
YARD::Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS = T.let(T.unsafe(nil), Hash)
|
11334
11492
|
|
11335
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11493
|
+
# source://yard//lib/yard/parser/source_parser.rb#65
|
11336
11494
|
YARD::Parser::SourceParser::ENCODING_LINE = T.let(T.unsafe(nil), Regexp)
|
11337
11495
|
|
11338
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11496
|
+
# source://yard//lib/yard/parser/source_parser.rb#66
|
11339
11497
|
YARD::Parser::SourceParser::FROZEN_STRING_LINE = T.let(T.unsafe(nil), Regexp)
|
11340
11498
|
|
11341
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11499
|
+
# source://yard//lib/yard/parser/source_parser.rb#64
|
11342
11500
|
YARD::Parser::SourceParser::SHEBANG_LINE = T.let(T.unsafe(nil), Regexp)
|
11343
11501
|
|
11344
11502
|
# Raised when an object is recognized but cannot be documented. This
|
11345
11503
|
# generally occurs when the Ruby syntax used to declare an object is
|
11346
11504
|
# too dynamic in nature.
|
11347
11505
|
#
|
11348
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11506
|
+
# source://yard//lib/yard/parser/source_parser.rb#9
|
11349
11507
|
class YARD::Parser::UndocumentableError < ::RuntimeError; end
|
11350
11508
|
|
11351
11509
|
# The root path for YARD source libraries
|
@@ -14620,42 +14778,42 @@ module YARD::Tags; end
|
|
14620
14778
|
# @see tag:!method
|
14621
14779
|
# @since 0.7.0
|
14622
14780
|
#
|
14623
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14781
|
+
# source://yard//lib/yard/tags/directives.rb#460
|
14624
14782
|
class YARD::Tags::AttributeDirective < ::YARD::Tags::MethodDirective
|
14625
14783
|
# @since 0.7.0
|
14626
14784
|
#
|
14627
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14785
|
+
# source://yard//lib/yard/tags/directives.rb#461
|
14628
14786
|
def after_parse; end
|
14629
14787
|
|
14630
14788
|
protected
|
14631
14789
|
|
14632
14790
|
# @since 0.7.0
|
14633
14791
|
#
|
14634
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14792
|
+
# source://yard//lib/yard/tags/directives.rb#469
|
14635
14793
|
def method_name; end
|
14636
14794
|
|
14637
14795
|
# @since 0.7.0
|
14638
14796
|
#
|
14639
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14797
|
+
# source://yard//lib/yard/tags/directives.rb#475
|
14640
14798
|
def method_signature; end
|
14641
14799
|
|
14642
14800
|
private
|
14643
14801
|
|
14644
14802
|
# @since 0.7.0
|
14645
14803
|
#
|
14646
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14804
|
+
# source://yard//lib/yard/tags/directives.rb#485
|
14647
14805
|
def create_attribute_data(object); end
|
14648
14806
|
|
14649
14807
|
# @return [Boolean]
|
14650
14808
|
# @since 0.7.0
|
14651
14809
|
#
|
14652
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14810
|
+
# source://yard//lib/yard/tags/directives.rb#515
|
14653
14811
|
def readable?; end
|
14654
14812
|
|
14655
14813
|
# @return [Boolean]
|
14656
14814
|
# @since 0.7.0
|
14657
14815
|
#
|
14658
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14816
|
+
# source://yard//lib/yard/tags/directives.rb#511
|
14659
14817
|
def writable?; end
|
14660
14818
|
end
|
14661
14819
|
|
@@ -14789,14 +14947,14 @@ end
|
|
14789
14947
|
# @see Library.define_directive
|
14790
14948
|
# @since 0.8.0
|
14791
14949
|
#
|
14792
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14950
|
+
# source://yard//lib/yard/tags/directives.rb#22
|
14793
14951
|
class YARD::Tags::Directive
|
14794
14952
|
# @param tag [Tag] the meta-data tag containing all input to the docstring
|
14795
14953
|
# @param parser [DocstringParser] the docstring parser object
|
14796
14954
|
# @return [Directive] a new instance of Directive
|
14797
14955
|
# @since 0.8.0
|
14798
14956
|
#
|
14799
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14957
|
+
# source://yard//lib/yard/tags/directives.rb#54
|
14800
14958
|
def initialize(tag, parser); end
|
14801
14959
|
|
14802
14960
|
# Called after parsing all directives and tags in the docstring. Used
|
@@ -14805,7 +14963,7 @@ class YARD::Tags::Directive
|
|
14805
14963
|
# @return [void]
|
14806
14964
|
# @since 0.8.0
|
14807
14965
|
#
|
14808
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14966
|
+
# source://yard//lib/yard/tags/directives.rb#73
|
14809
14967
|
def after_parse; end
|
14810
14968
|
|
14811
14969
|
# Called when processing the directive. Subclasses should implement
|
@@ -14817,7 +14975,7 @@ class YARD::Tags::Directive
|
|
14817
14975
|
# @return [void]
|
14818
14976
|
# @since 0.8.0
|
14819
14977
|
#
|
14820
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14978
|
+
# source://yard//lib/yard/tags/directives.rb#68
|
14821
14979
|
def call; end
|
14822
14980
|
|
14823
14981
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14829,7 +14987,7 @@ class YARD::Tags::Directive
|
|
14829
14987
|
# @return [nil] if no expansion should take place for this directive
|
14830
14988
|
# @since 0.8.0
|
14831
14989
|
#
|
14832
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14990
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14833
14991
|
def expanded_text; end
|
14834
14992
|
|
14835
14993
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14841,7 +14999,7 @@ class YARD::Tags::Directive
|
|
14841
14999
|
# @return [nil] if no expansion should take place for this directive
|
14842
15000
|
# @since 0.8.0
|
14843
15001
|
#
|
14844
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15002
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14845
15003
|
def expanded_text=(_arg0); end
|
14846
15004
|
|
14847
15005
|
# @return [Handlers::Base, nil] the handler object the docstring parser
|
@@ -14849,33 +15007,33 @@ class YARD::Tags::Directive
|
|
14849
15007
|
# through {Parser::SourceParser}.
|
14850
15008
|
# @since 0.8.0
|
14851
15009
|
#
|
14852
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15010
|
+
# source://yard//lib/yard/tags/directives.rb#48
|
14853
15011
|
def handler; end
|
14854
15012
|
|
14855
15013
|
# @return [CodeObjects::Base, nil] the object the parent docstring is
|
14856
15014
|
# attached to. May be nil.
|
14857
15015
|
# @since 0.8.0
|
14858
15016
|
#
|
14859
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15017
|
+
# source://yard//lib/yard/tags/directives.rb#42
|
14860
15018
|
def object; end
|
14861
15019
|
|
14862
15020
|
# @return [DocstringParser] the parser that is parsing all tag
|
14863
15021
|
# information out of the docstring
|
14864
15022
|
# @since 0.8.0
|
14865
15023
|
#
|
14866
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15024
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14867
15025
|
def parser=(_arg0); end
|
14868
15026
|
|
14869
15027
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14870
15028
|
# @since 0.8.0
|
14871
15029
|
#
|
14872
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15030
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14873
15031
|
def tag; end
|
14874
15032
|
|
14875
15033
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14876
15034
|
# @since 0.8.0
|
14877
15035
|
#
|
14878
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15036
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14879
15037
|
def tag=(_arg0); end
|
14880
15038
|
|
14881
15039
|
protected
|
@@ -14883,14 +15041,14 @@ class YARD::Tags::Directive
|
|
14883
15041
|
# @return [Boolean]
|
14884
15042
|
# @since 0.8.0
|
14885
15043
|
#
|
14886
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15044
|
+
# source://yard//lib/yard/tags/directives.rb#79
|
14887
15045
|
def inside_directive?; end
|
14888
15046
|
|
14889
15047
|
# @return [DocstringParser] the parser that is parsing all tag
|
14890
15048
|
# information out of the docstring
|
14891
15049
|
# @since 0.8.0
|
14892
15050
|
#
|
14893
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15051
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14894
15052
|
def parser; end
|
14895
15053
|
end
|
14896
15054
|
|
@@ -14914,11 +15072,11 @@ end
|
|
14914
15072
|
# @see tag:!group
|
14915
15073
|
# @since 0.6.0
|
14916
15074
|
#
|
14917
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15075
|
+
# source://yard//lib/yard/tags/directives.rb#104
|
14918
15076
|
class YARD::Tags::EndGroupDirective < ::YARD::Tags::Directive
|
14919
15077
|
# @since 0.6.0
|
14920
15078
|
#
|
14921
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15079
|
+
# source://yard//lib/yard/tags/directives.rb#105
|
14922
15080
|
def call; end
|
14923
15081
|
end
|
14924
15082
|
|
@@ -14939,11 +15097,11 @@ end
|
|
14939
15097
|
# @see tag:!endgroup
|
14940
15098
|
# @since 0.6.0
|
14941
15099
|
#
|
14942
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15100
|
+
# source://yard//lib/yard/tags/directives.rb#127
|
14943
15101
|
class YARD::Tags::GroupDirective < ::YARD::Tags::Directive
|
14944
15102
|
# @since 0.6.0
|
14945
15103
|
#
|
14946
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15104
|
+
# source://yard//lib/yard/tags/directives.rb#128
|
14947
15105
|
def call; end
|
14948
15106
|
end
|
14949
15107
|
|
@@ -15708,12 +15866,12 @@ end
|
|
15708
15866
|
# end
|
15709
15867
|
# @since 0.7.0
|
15710
15868
|
#
|
15711
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15869
|
+
# source://yard//lib/yard/tags/directives.rb#257
|
15712
15870
|
class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
15713
15871
|
# @raise [TagFormatError]
|
15714
15872
|
# @since 0.7.0
|
15715
15873
|
#
|
15716
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15874
|
+
# source://yard//lib/yard/tags/directives.rb#258
|
15717
15875
|
def call; end
|
15718
15876
|
|
15719
15877
|
private
|
@@ -15721,40 +15879,40 @@ class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
|
15721
15879
|
# @return [Boolean]
|
15722
15880
|
# @since 0.7.0
|
15723
15881
|
#
|
15724
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15882
|
+
# source://yard//lib/yard/tags/directives.rb#287
|
15725
15883
|
def anonymous?; end
|
15726
15884
|
|
15727
15885
|
# @return [Boolean]
|
15728
15886
|
# @since 0.7.0
|
15729
15887
|
#
|
15730
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15888
|
+
# source://yard//lib/yard/tags/directives.rb#276
|
15731
15889
|
def attach?; end
|
15732
15890
|
|
15733
15891
|
# @return [Boolean]
|
15734
15892
|
# @since 0.7.0
|
15735
15893
|
#
|
15736
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15894
|
+
# source://yard//lib/yard/tags/directives.rb#282
|
15737
15895
|
def class_method?; end
|
15738
15896
|
|
15739
15897
|
# @since 0.7.0
|
15740
15898
|
#
|
15741
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15899
|
+
# source://yard//lib/yard/tags/directives.rb#291
|
15742
15900
|
def expand(macro_data); end
|
15743
15901
|
|
15744
15902
|
# @since 0.7.0
|
15745
15903
|
#
|
15746
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15904
|
+
# source://yard//lib/yard/tags/directives.rb#307
|
15747
15905
|
def find_or_create; end
|
15748
15906
|
|
15749
15907
|
# @return [Boolean]
|
15750
15908
|
# @since 0.7.0
|
15751
15909
|
#
|
15752
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15910
|
+
# source://yard//lib/yard/tags/directives.rb#271
|
15753
15911
|
def new?; end
|
15754
15912
|
|
15755
15913
|
# @since 0.7.0
|
15756
15914
|
#
|
15757
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15915
|
+
# source://yard//lib/yard/tags/directives.rb#331
|
15758
15916
|
def warn; end
|
15759
15917
|
end
|
15760
15918
|
|
@@ -15787,49 +15945,49 @@ end
|
|
15787
15945
|
# @see tag:!attribute
|
15788
15946
|
# @since 0.7.0
|
15789
15947
|
#
|
15790
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15948
|
+
# source://yard//lib/yard/tags/directives.rb#367
|
15791
15949
|
class YARD::Tags::MethodDirective < ::YARD::Tags::Directive
|
15792
15950
|
# @since 0.7.0
|
15793
15951
|
#
|
15794
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15952
|
+
# source://yard//lib/yard/tags/directives.rb#372
|
15795
15953
|
def after_parse; end
|
15796
15954
|
|
15797
15955
|
# @since 0.7.0
|
15798
15956
|
#
|
15799
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15957
|
+
# source://yard//lib/yard/tags/directives.rb#370
|
15800
15958
|
def call; end
|
15801
15959
|
|
15802
15960
|
protected
|
15803
15961
|
|
15804
15962
|
# @since 0.7.0
|
15805
15963
|
#
|
15806
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15964
|
+
# source://yard//lib/yard/tags/directives.rb#412
|
15807
15965
|
def create_object; end
|
15808
15966
|
|
15809
15967
|
# @since 0.7.0
|
15810
15968
|
#
|
15811
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15969
|
+
# source://yard//lib/yard/tags/directives.rb#380
|
15812
15970
|
def method_name; end
|
15813
15971
|
|
15814
15972
|
# @since 0.7.0
|
15815
15973
|
#
|
15816
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15974
|
+
# source://yard//lib/yard/tags/directives.rb#389
|
15817
15975
|
def method_signature; end
|
15818
15976
|
|
15819
15977
|
# @since 0.7.0
|
15820
15978
|
#
|
15821
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15979
|
+
# source://yard//lib/yard/tags/directives.rb#393
|
15822
15980
|
def sanitized_tag_signature; end
|
15823
15981
|
|
15824
15982
|
# @since 0.7.0
|
15825
15983
|
#
|
15826
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15984
|
+
# source://yard//lib/yard/tags/directives.rb#402
|
15827
15985
|
def use_indented_text; end
|
15828
15986
|
end
|
15829
15987
|
|
15830
15988
|
# @since 0.7.0
|
15831
15989
|
#
|
15832
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15990
|
+
# source://yard//lib/yard/tags/directives.rb#368
|
15833
15991
|
YARD::Tags::MethodDirective::SCOPE_MATCH = T.let(T.unsafe(nil), Regexp)
|
15834
15992
|
|
15835
15993
|
# source://yard//lib/yard/tags/option_tag.rb#4
|
@@ -15941,11 +16099,11 @@ end
|
|
15941
16099
|
# # }
|
15942
16100
|
# @since 0.8.0
|
15943
16101
|
#
|
15944
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16102
|
+
# source://yard//lib/yard/tags/directives.rb#544
|
15945
16103
|
class YARD::Tags::ParseDirective < ::YARD::Tags::Directive
|
15946
16104
|
# @since 0.8.0
|
15947
16105
|
#
|
15948
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16106
|
+
# source://yard//lib/yard/tags/directives.rb#545
|
15949
16107
|
def call; end
|
15950
16108
|
end
|
15951
16109
|
|
@@ -16029,11 +16187,11 @@ end
|
|
16029
16187
|
# def method2; end
|
16030
16188
|
# @since 0.7.0
|
16031
16189
|
#
|
16032
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16190
|
+
# source://yard//lib/yard/tags/directives.rb#578
|
16033
16191
|
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
|
16034
16192
|
# @since 0.7.0
|
16035
16193
|
#
|
16036
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16194
|
+
# source://yard//lib/yard/tags/directives.rb#579
|
16037
16195
|
def call; end
|
16038
16196
|
end
|
16039
16197
|
|
@@ -16064,7 +16222,7 @@ class YARD::Tags::Tag
|
|
16064
16222
|
# @param name [String] optional key name which the tag refers to
|
16065
16223
|
# @return [Tag] a new instance of Tag
|
16066
16224
|
#
|
16067
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16225
|
+
# source://yard//lib/yard/tags/tag.rb#45
|
16068
16226
|
def initialize(tag_name, text, types = T.unsafe(nil), name = T.unsafe(nil)); end
|
16069
16227
|
|
16070
16228
|
# Provides a plain English summary of the type specification, or nil
|
@@ -16073,27 +16231,29 @@ class YARD::Tags::Tag
|
|
16073
16231
|
# @return [String] a plain English description of the associated types
|
16074
16232
|
# @return [nil] if no types are provided or not parsable
|
16075
16233
|
#
|
16076
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16234
|
+
# source://yard//lib/yard/tags/tag.rb#66
|
16077
16235
|
def explain_types; end
|
16078
16236
|
|
16079
16237
|
# @return [String] a name associated with the tag
|
16238
|
+
# @return [nil] if no tag name is supplied
|
16080
16239
|
#
|
16081
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16240
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16082
16241
|
def name; end
|
16083
16242
|
|
16084
16243
|
# @return [String] a name associated with the tag
|
16244
|
+
# @return [nil] if no tag name is supplied
|
16085
16245
|
#
|
16086
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16246
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16087
16247
|
def name=(_arg0); end
|
16088
16248
|
|
16089
16249
|
# @return [CodeObjects::Base] the associated object
|
16090
16250
|
#
|
16091
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16251
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16092
16252
|
def object; end
|
16093
16253
|
|
16094
16254
|
# @return [CodeObjects::Base] the associated object
|
16095
16255
|
#
|
16096
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16256
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16097
16257
|
def object=(_arg0); end
|
16098
16258
|
|
16099
16259
|
# @return [String] the name of the tag
|
@@ -16124,7 +16284,7 @@ class YARD::Tags::Tag
|
|
16124
16284
|
# @return [String] the first of the list of specified types
|
16125
16285
|
# @see #types
|
16126
16286
|
#
|
16127
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16287
|
+
# source://yard//lib/yard/tags/tag.rb#57
|
16128
16288
|
def type; end
|
16129
16289
|
|
16130
16290
|
# @return [Array<String>] a list of types associated with the tag
|
@@ -16315,11 +16475,11 @@ end
|
|
16315
16475
|
# def method2; end
|
16316
16476
|
# @since 0.7.0
|
16317
16477
|
#
|
16318
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16478
|
+
# source://yard//lib/yard/tags/directives.rb#610
|
16319
16479
|
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
|
16320
16480
|
# @since 0.7.0
|
16321
16481
|
#
|
16322
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16482
|
+
# source://yard//lib/yard/tags/directives.rb#611
|
16323
16483
|
def call; end
|
16324
16484
|
end
|
16325
16485
|
|
@@ -16335,7 +16495,7 @@ module YARD::Templates; end
|
|
16335
16495
|
# * To render a template, call {render}.
|
16336
16496
|
# * To register a template path in the lookup paths, call {register_template_path}.
|
16337
16497
|
#
|
16338
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16498
|
+
# source://yard//lib/yard/templates/engine.rb#11
|
16339
16499
|
module YARD::Templates::Engine
|
16340
16500
|
class << self
|
16341
16501
|
# Passes a set of objects to the +:fulldoc+ template for full documentation generation.
|
@@ -16347,7 +16507,7 @@ module YARD::Templates::Engine
|
|
16347
16507
|
# @param options [Hash] (see {render})
|
16348
16508
|
# @return [void]
|
16349
16509
|
#
|
16350
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16510
|
+
# source://yard//lib/yard/templates/engine.rb#100
|
16351
16511
|
def generate(objects, options = T.unsafe(nil)); end
|
16352
16512
|
|
16353
16513
|
# Registers a new template path in {template_paths}
|
@@ -16355,7 +16515,7 @@ module YARD::Templates::Engine
|
|
16355
16515
|
# @param path [String] a new template path
|
16356
16516
|
# @return [void]
|
16357
16517
|
#
|
16358
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16518
|
+
# source://yard//lib/yard/templates/engine.rb#20
|
16359
16519
|
def register_template_path(path); end
|
16360
16520
|
|
16361
16521
|
# Renders a template on a {CodeObjects::Base code object} using
|
@@ -16376,7 +16536,7 @@ module YARD::Templates::Engine
|
|
16376
16536
|
# @param options [Hash] the options hash
|
16377
16537
|
# @return [String] the rendered template
|
16378
16538
|
#
|
16379
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16539
|
+
# source://yard//lib/yard/templates/engine.rb#81
|
16380
16540
|
def render(options = T.unsafe(nil)); end
|
16381
16541
|
|
16382
16542
|
# Creates a template module representing the path. Searches on disk
|
@@ -16390,7 +16550,7 @@ module YARD::Templates::Engine
|
|
16390
16550
|
# {template_paths} on disk.
|
16391
16551
|
# @return [Template] the module representing the template
|
16392
16552
|
#
|
16393
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16553
|
+
# source://yard//lib/yard/templates/engine.rb#34
|
16394
16554
|
def template(*path); end
|
16395
16555
|
|
16396
16556
|
# Forces creation of a template at +path+ within a +full_path+.
|
@@ -16399,17 +16559,17 @@ module YARD::Templates::Engine
|
|
16399
16559
|
# @param full_paths [Array<String>] the full path on disk of the template
|
16400
16560
|
# @return [Template] the template module representing the +path+
|
16401
16561
|
#
|
16402
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16562
|
+
# source://yard//lib/yard/templates/engine.rb#52
|
16403
16563
|
def template!(path, full_paths = T.unsafe(nil)); end
|
16404
16564
|
|
16405
16565
|
# @return [Array<String>] the list of registered template paths
|
16406
16566
|
#
|
16407
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16567
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16408
16568
|
def template_paths; end
|
16409
16569
|
|
16410
16570
|
# @return [Array<String>] the list of registered template paths
|
16411
16571
|
#
|
16412
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16572
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16413
16573
|
def template_paths=(_arg0); end
|
16414
16574
|
|
16415
16575
|
# Serializes the results of a block with a +serializer+ object.
|
@@ -16420,7 +16580,7 @@ module YARD::Templates::Engine
|
|
16420
16580
|
# @yield a block whose result will be serialize
|
16421
16581
|
# @yieldreturn [String] the contents to serialize
|
16422
16582
|
#
|
16423
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16583
|
+
# source://yard//lib/yard/templates/engine.rb#114
|
16424
16584
|
def with_serializer(object, serializer); end
|
16425
16585
|
|
16426
16586
|
private
|
@@ -16435,7 +16595,7 @@ module YARD::Templates::Engine
|
|
16435
16595
|
# @return [Array<String>] a list of full paths that are existing
|
16436
16596
|
# candidates for a template module
|
16437
16597
|
#
|
16438
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16598
|
+
# source://yard//lib/yard/templates/engine.rb#160
|
16439
16599
|
def find_template_paths(from_template, path); end
|
16440
16600
|
|
16441
16601
|
# Sets default options on the options hash
|
@@ -16446,7 +16606,7 @@ module YARD::Templates::Engine
|
|
16446
16606
|
# @param options [Hash] the options hash
|
16447
16607
|
# @return [void]
|
16448
16608
|
#
|
16449
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16609
|
+
# source://yard//lib/yard/templates/engine.rb#140
|
16450
16610
|
def set_default_options(options = T.unsafe(nil)); end
|
16451
16611
|
|
16452
16612
|
# The name of the module that represents a +path+
|
@@ -16454,7 +16614,7 @@ module YARD::Templates::Engine
|
|
16454
16614
|
# @param path [String] the path to generate a module name for
|
16455
16615
|
# @return [String] the module name
|
16456
16616
|
#
|
16457
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16617
|
+
# source://yard//lib/yard/templates/engine.rb#175
|
16458
16618
|
def template_module_name(path); end
|
16459
16619
|
end
|
16460
16620
|
end
|
@@ -17865,7 +18025,7 @@ end
|
|
17865
18025
|
#
|
17866
18026
|
# @see CLI::YardocOptions
|
17867
18027
|
#
|
17868
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18028
|
+
# source://yard//lib/yard/templates/template_options.rb#9
|
17869
18029
|
class YARD::Templates::TemplateOptions < ::YARD::Options
|
17870
18030
|
# @return [OpenStruct] an open struct containing any global state across all
|
17871
18031
|
# generated objects in a template.
|
@@ -17908,7 +18068,7 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17908
18068
|
# @return [Boolean] whether a mixin matches the embed_mixins list
|
17909
18069
|
# @return [nil] if the mixin is not a module object
|
17910
18070
|
#
|
17911
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18071
|
+
# source://yard//lib/yard/templates/template_options.rb#77
|
17912
18072
|
def embed_mixins_match?(mixin); end
|
17913
18073
|
|
17914
18074
|
# @return [Symbol] the template output format
|
@@ -17955,12 +18115,12 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17955
18115
|
|
17956
18116
|
# @return [Boolean] whether the page is the "index"
|
17957
18117
|
#
|
17958
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18118
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17959
18119
|
def index; end
|
17960
18120
|
|
17961
18121
|
# @return [Boolean] whether the page is the "index"
|
17962
18122
|
#
|
17963
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18123
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17964
18124
|
def index=(_arg0); end
|
17965
18125
|
|
17966
18126
|
# @return [Symbol] the markup format to use when parsing docstrings
|
@@ -17975,51 +18135,51 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17975
18135
|
|
17976
18136
|
# @return [Class] the markup provider class for the markup format
|
17977
18137
|
#
|
17978
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18138
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
17979
18139
|
def markup_provider; end
|
17980
18140
|
|
17981
18141
|
# @return [Class] the markup provider class for the markup format
|
17982
18142
|
#
|
17983
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18143
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
17984
18144
|
def markup_provider=(_arg0); end
|
17985
18145
|
|
17986
18146
|
# @deprecated use {#highlight} instead.
|
17987
18147
|
# @return [Boolean] whether highlighting should be ignored
|
17988
18148
|
#
|
17989
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18149
|
+
# source://yard//lib/yard/templates/template_options.rb#56
|
17990
18150
|
def no_highlight; end
|
17991
18151
|
|
17992
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18152
|
+
# source://yard//lib/yard/templates/template_options.rb#57
|
17993
18153
|
def no_highlight=(value); end
|
17994
18154
|
|
17995
18155
|
# @return [CodeObjects::Base] the main object being generated in the template
|
17996
18156
|
#
|
17997
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18157
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
17998
18158
|
def object; end
|
17999
18159
|
|
18000
18160
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18001
18161
|
#
|
18002
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18162
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18003
18163
|
def object=(_arg0); end
|
18004
18164
|
|
18005
18165
|
# @return [CodeObjects::Base] the owner of the generated object
|
18006
18166
|
#
|
18007
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18167
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18008
18168
|
def owner; end
|
18009
18169
|
|
18010
18170
|
# @return [CodeObjects::Base] the owner of the generated object
|
18011
18171
|
#
|
18012
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18172
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18013
18173
|
def owner=(_arg0); end
|
18014
18174
|
|
18015
18175
|
# @return [String] the title of a given page
|
18016
18176
|
#
|
18017
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18177
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18018
18178
|
def page_title; end
|
18019
18179
|
|
18020
18180
|
# @return [String] the title of a given page
|
18021
18181
|
#
|
18022
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18182
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18023
18183
|
def page_title=(_arg0); end
|
18024
18184
|
|
18025
18185
|
# @return [Boolean] whether serialization should be performed
|
@@ -18035,13 +18195,13 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18035
18195
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18036
18196
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18037
18197
|
#
|
18038
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18198
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18039
18199
|
def serializer; end
|
18040
18200
|
|
18041
18201
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18042
18202
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18043
18203
|
#
|
18044
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18204
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18045
18205
|
def serializer=(_arg0); end
|
18046
18206
|
|
18047
18207
|
# @return [Symbol] the template name used to render output
|
@@ -18056,22 +18216,22 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18056
18216
|
|
18057
18217
|
# @return [Symbol] the template type used to generate output
|
18058
18218
|
#
|
18059
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18219
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18060
18220
|
def type; end
|
18061
18221
|
|
18062
18222
|
# @return [Symbol] the template type used to generate output
|
18063
18223
|
#
|
18064
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18224
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18065
18225
|
def type=(_arg0); end
|
18066
18226
|
|
18067
18227
|
# @return [Verifier] the verifier object
|
18068
18228
|
#
|
18069
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18229
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18070
18230
|
def verifier; end
|
18071
18231
|
|
18072
18232
|
# @return [Verifier] the verifier object
|
18073
18233
|
#
|
18074
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18234
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18075
18235
|
def verifier=(_arg0); end
|
18076
18236
|
end
|
18077
18237
|
|