checkoff 0.219.0 → 0.221.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/.circleci/config.yml +3 -4
- data/.overcommit.yml +2 -0
- data/.rubocop.yml +4 -0
- data/.rubocop_todo.yml +2 -1
- data/Gemfile +1 -0
- data/Gemfile.lock +42 -8
- data/Makefile +13 -7
- data/bin/tapioca +1 -1
- data/checkoff.gemspec +1 -0
- data/fix.sh +1 -0
- data/lib/checkoff/tasks.rb +8 -2
- data/lib/checkoff/version.rb +1 -1
- data/sorbet/rbi/gems/{activesupport@7.1.3.rbi → activesupport@7.1.5.rbi} +157 -160
- data/sorbet/rbi/gems/brakeman@6.2.2.rbi +222 -0
- data/sorbet/rbi/gems/{i18n@1.14.1.rbi → i18n@1.14.6.rbi} +135 -102
- data/sorbet/rbi/gems/{logger@1.6.1.rbi → logger@1.6.2.rbi} +4 -1
- data/sorbet/rbi/gems/{mutex_m@0.2.0.rbi → mutex_m@0.3.0.rbi} +15 -12
- data/sorbet/rbi/gems/{nokogiri@1.16.7.rbi → nokogiri@1.17.0.rbi} +1693 -803
- data/sorbet/rbi/gems/{racc@1.7.3.rbi → racc@1.8.1.rbi} +33 -33
- data/sorbet/rbi/gems/{rack@3.0.8.rbi → rack@3.1.8.rbi} +697 -985
- data/sorbet/rbi/gems/{rexml@3.2.6.rbi → rexml@3.3.9.rbi} +354 -278
- data/sorbet/rbi/gems/rubocop-rspec@3.0.0.rbi +7546 -0
- data/sorbet/rbi/gems/securerandom@0.4.0.rbi +75 -0
- data/sorbet/rbi/gems/solargraph-rails@1.1.0-9dc37915bd4f3b169046e34db6fb32193ab347d8.rbi +320 -0
- data/sorbet/rbi/gems/{tapioca@0.16.4.rbi → tapioca@0.16.5.rbi} +89 -76
- data/sorbet/rbi/gems/{yard@0.9.34.rbi → yard@0.9.37.rbi} +429 -270
- metadata +33 -16
- data/sorbet/rbi/gems/ostruct@0.6.1.rbi +0 -354
- /data/sorbet/rbi/gems/{drb@2.2.0.rbi → drb@2.2.1.rbi} +0 -0
- /data/sorbet/rbi/gems/{gli@2.21.1.rbi → gli@2.22.0.rbi} +0 -0
- /data/sorbet/rbi/gems/{overcommit@0.64.0.rbi → overcommit@0.64.1.rbi} +0 -0
@@ -2481,7 +2481,7 @@ class YARD::CodeObjects::Base
|
|
2481
2481
|
# the paths are equal
|
2482
2482
|
# @return [Boolean] whether or not the objects are considered the same
|
2483
2483
|
#
|
2484
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2484
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2485
2485
|
def ==(other); end
|
2486
2486
|
|
2487
2487
|
# Accesses a custom attribute on the object
|
@@ -2490,7 +2490,7 @@ class YARD::CodeObjects::Base
|
|
2490
2490
|
# @return [Object, nil] the custom attribute or nil if not found.
|
2491
2491
|
# @see #[]=
|
2492
2492
|
#
|
2493
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2493
|
+
# source://yard//lib/yard/code_objects/base.rb#343
|
2494
2494
|
def [](key); end
|
2495
2495
|
|
2496
2496
|
# Sets a custom attribute on the object
|
@@ -2500,7 +2500,7 @@ class YARD::CodeObjects::Base
|
|
2500
2500
|
# @return [void]
|
2501
2501
|
# @see #[]
|
2502
2502
|
#
|
2503
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2503
|
+
# source://yard//lib/yard/code_objects/base.rb#356
|
2504
2504
|
def []=(key, value); end
|
2505
2505
|
|
2506
2506
|
# Associates a file with a code object, optionally adding the line where it was defined.
|
@@ -2521,7 +2521,7 @@ class YARD::CodeObjects::Base
|
|
2521
2521
|
# @see Docstring#add_tag
|
2522
2522
|
# @since 0.8.4
|
2523
2523
|
#
|
2524
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2524
|
+
# source://yard//lib/yard/code_objects/base.rb#561
|
2525
2525
|
def add_tag(*tags); end
|
2526
2526
|
|
2527
2527
|
# The non-localized documentation string associated with the object
|
@@ -2548,7 +2548,7 @@ class YARD::CodeObjects::Base
|
|
2548
2548
|
# the locale of the documentation string.
|
2549
2549
|
# @return [Docstring] the documentation string
|
2550
2550
|
#
|
2551
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2551
|
+
# source://yard//lib/yard/code_objects/base.rb#405
|
2552
2552
|
def docstring(locale = T.unsafe(nil)); end
|
2553
2553
|
|
2554
2554
|
# Attaches a docstring to a code object by parsing the comments attached to the statement
|
@@ -2557,7 +2557,7 @@ class YARD::CodeObjects::Base
|
|
2557
2557
|
# @param comments [String, Array<String>, Docstring] the comments attached to the code object to be parsed
|
2558
2558
|
# into a docstring and meta tags.
|
2559
2559
|
#
|
2560
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2560
|
+
# source://yard//lib/yard/code_objects/base.rb#427
|
2561
2561
|
def docstring=(comments); end
|
2562
2562
|
|
2563
2563
|
# Marks whether or not the method is conditionally defined at runtime
|
@@ -2588,7 +2588,7 @@ class YARD::CodeObjects::Base
|
|
2588
2588
|
# the paths are equal
|
2589
2589
|
# @return [Boolean] whether or not the objects are considered the same
|
2590
2590
|
#
|
2591
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2591
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2592
2592
|
def eql?(other); end
|
2593
2593
|
|
2594
2594
|
# Tests if another object is equal to this, including a proxy
|
@@ -2597,15 +2597,16 @@ class YARD::CodeObjects::Base
|
|
2597
2597
|
# the paths are equal
|
2598
2598
|
# @return [Boolean] whether or not the objects are considered the same
|
2599
2599
|
#
|
2600
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2600
|
+
# source://yard//lib/yard/code_objects/base.rb#323
|
2601
2601
|
def equal?(other); end
|
2602
2602
|
|
2603
2603
|
# Returns the filename the object was first parsed at, taking
|
2604
2604
|
# definitions with docstrings first.
|
2605
2605
|
#
|
2606
2606
|
# @return [String] a filename
|
2607
|
+
# @return [nil] if there is no file associated with the object
|
2607
2608
|
#
|
2608
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2609
|
+
# source://yard//lib/yard/code_objects/base.rb#307
|
2609
2610
|
def file; end
|
2610
2611
|
|
2611
2612
|
# The files the object was defined in. To add a file, use {#add_file}.
|
@@ -2630,7 +2631,7 @@ class YARD::CodeObjects::Base
|
|
2630
2631
|
# @return [String] the rendered template
|
2631
2632
|
# @see Templates::Engine#render
|
2632
2633
|
#
|
2633
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2634
|
+
# source://yard//lib/yard/code_objects/base.rb#505
|
2634
2635
|
def format(options = T.unsafe(nil)); end
|
2635
2636
|
|
2636
2637
|
# @return [String] the group this object is associated with
|
@@ -2650,19 +2651,19 @@ class YARD::CodeObjects::Base
|
|
2650
2651
|
# @return [Boolean]
|
2651
2652
|
# @see Docstring#has_tag?
|
2652
2653
|
#
|
2653
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2654
|
+
# source://yard//lib/yard/code_objects/base.rb#556
|
2654
2655
|
def has_tag?(name); end
|
2655
2656
|
|
2656
2657
|
# @return [Integer] the object's hash value (for equality checking)
|
2657
2658
|
#
|
2658
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2659
|
+
# source://yard//lib/yard/code_objects/base.rb#334
|
2659
2660
|
def hash; end
|
2660
2661
|
|
2661
2662
|
# Inspects the object, returning the type and path
|
2662
2663
|
#
|
2663
2664
|
# @return [String] a string describing the object
|
2664
2665
|
#
|
2665
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2666
|
+
# source://yard//lib/yard/code_objects/base.rb#513
|
2666
2667
|
def inspect; end
|
2667
2668
|
|
2668
2669
|
# Returns the line the object was first parsed at (or nil)
|
@@ -2670,13 +2671,13 @@ class YARD::CodeObjects::Base
|
|
2670
2671
|
# @return [Fixnum] the line where the object was first defined.
|
2671
2672
|
# @return [nil] if there is no line associated with the object
|
2672
2673
|
#
|
2673
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2674
|
+
# source://yard//lib/yard/code_objects/base.rb#315
|
2674
2675
|
def line; end
|
2675
2676
|
|
2676
2677
|
# @overload dynamic_attr_name
|
2677
2678
|
# @overload dynamic_attr_name=
|
2678
2679
|
#
|
2679
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2680
|
+
# source://yard//lib/yard/code_objects/base.rb#373
|
2680
2681
|
def method_missing(meth, *args, &block); end
|
2681
2682
|
|
2682
2683
|
# The name of the object
|
@@ -2704,7 +2705,7 @@ class YARD::CodeObjects::Base
|
|
2704
2705
|
# for {Registry.root}). If obj is nil, the object is unregistered
|
2705
2706
|
# from the Registry.
|
2706
2707
|
#
|
2707
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2708
|
+
# source://yard//lib/yard/code_objects/base.rb#522
|
2708
2709
|
def namespace=(obj); end
|
2709
2710
|
|
2710
2711
|
# The namespace the object is defined in. If the object is in the
|
@@ -2721,7 +2722,7 @@ class YARD::CodeObjects::Base
|
|
2721
2722
|
# for {Registry.root}). If obj is nil, the object is unregistered
|
2722
2723
|
# from the Registry.
|
2723
2724
|
#
|
2724
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2725
|
+
# source://yard//lib/yard/code_objects/base.rb#522
|
2725
2726
|
def parent=(obj); end
|
2726
2727
|
|
2727
2728
|
# Represents the unique path of the object. The default implementation
|
@@ -2734,19 +2735,19 @@ class YARD::CodeObjects::Base
|
|
2734
2735
|
# @return [String] the unique path of the object
|
2735
2736
|
# @see #sep
|
2736
2737
|
#
|
2737
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2738
|
+
# source://yard//lib/yard/code_objects/base.rb#453
|
2738
2739
|
def path; end
|
2739
2740
|
|
2740
2741
|
# @param other [Base, String] another code object (or object path)
|
2741
2742
|
# @return [String] the shortest relative path from this object to +other+
|
2742
2743
|
# @since 0.5.3
|
2743
2744
|
#
|
2744
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2745
|
+
# source://yard//lib/yard/code_objects/base.rb#475
|
2745
2746
|
def relative_path(other); end
|
2746
2747
|
|
2747
2748
|
# @return [Boolean] whether or not this object is a RootObject
|
2748
2749
|
#
|
2749
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2750
|
+
# source://yard//lib/yard/code_objects/base.rb#567
|
2750
2751
|
def root?; end
|
2751
2752
|
|
2752
2753
|
# Override this method with a custom component separator. For instance,
|
@@ -2757,7 +2758,7 @@ class YARD::CodeObjects::Base
|
|
2757
2758
|
# @return [String] the component that separates the namespace path
|
2758
2759
|
# and the name (default is {NSEP})
|
2759
2760
|
#
|
2760
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2761
|
+
# source://yard//lib/yard/code_objects/base.rb#576
|
2761
2762
|
def sep; end
|
2762
2763
|
|
2763
2764
|
# The one line signature representing an object. For a method, this will
|
@@ -2790,7 +2791,7 @@ class YARD::CodeObjects::Base
|
|
2790
2791
|
# @param statement [#source, String] the +Parser::Statement+ holding the source code or the raw source
|
2791
2792
|
# as a +String+ for the definition of the code object only (not the block)
|
2792
2793
|
#
|
2793
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2794
|
+
# source://yard//lib/yard/code_objects/base.rb#388
|
2794
2795
|
def source=(statement); end
|
2795
2796
|
|
2796
2797
|
# Language of the source code associated with the object. Defaults to
|
@@ -2813,14 +2814,14 @@ class YARD::CodeObjects::Base
|
|
2813
2814
|
#
|
2814
2815
|
# @see Docstring#tag
|
2815
2816
|
#
|
2816
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2817
|
+
# source://yard//lib/yard/code_objects/base.rb#548
|
2817
2818
|
def tag(name); end
|
2818
2819
|
|
2819
2820
|
# Gets a list of tags from the {#docstring}
|
2820
2821
|
#
|
2821
2822
|
# @see Docstring#tags
|
2822
2823
|
#
|
2823
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2824
|
+
# source://yard//lib/yard/code_objects/base.rb#552
|
2824
2825
|
def tags(name = T.unsafe(nil)); end
|
2825
2826
|
|
2826
2827
|
# @note Override this method if your object has a special title that does
|
@@ -2829,12 +2830,12 @@ class YARD::CodeObjects::Base
|
|
2829
2830
|
# @return [String] the display title for an object
|
2830
2831
|
# @see 0.8.4
|
2831
2832
|
#
|
2832
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2833
|
+
# source://yard//lib/yard/code_objects/base.rb#468
|
2833
2834
|
def title; end
|
2834
2835
|
|
2835
2836
|
# @return [nil] this object does not turn into an array
|
2836
2837
|
#
|
2837
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2838
|
+
# source://yard//lib/yard/code_objects/base.rb#337
|
2838
2839
|
def to_ary; end
|
2839
2840
|
|
2840
2841
|
# Represents the unique path of the object. The default implementation
|
@@ -2847,7 +2848,7 @@ class YARD::CodeObjects::Base
|
|
2847
2848
|
# @return [String] the unique path of the object
|
2848
2849
|
# @see #sep
|
2849
2850
|
#
|
2850
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2851
|
+
# source://yard//lib/yard/code_objects/base.rb#453
|
2851
2852
|
def to_s; end
|
2852
2853
|
|
2853
2854
|
# Default type is the lowercase class name without the "Object" suffix.
|
@@ -2855,7 +2856,7 @@ class YARD::CodeObjects::Base
|
|
2855
2856
|
#
|
2856
2857
|
# @return [Symbol] the type of code object this represents
|
2857
2858
|
#
|
2858
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2859
|
+
# source://yard//lib/yard/code_objects/base.rb#437
|
2859
2860
|
def type; end
|
2860
2861
|
|
2861
2862
|
# @return [Symbol] the visibility of an object (:public, :private, :protected)
|
@@ -2878,7 +2879,7 @@ class YARD::CodeObjects::Base
|
|
2878
2879
|
# @see #copy_to
|
2879
2880
|
# @since 0.8.0
|
2880
2881
|
#
|
2881
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2882
|
+
# source://yard//lib/yard/code_objects/base.rb#587
|
2882
2883
|
def copyable_attributes; end
|
2883
2884
|
|
2884
2885
|
private
|
@@ -2888,10 +2889,10 @@ class YARD::CodeObjects::Base
|
|
2888
2889
|
# @param source [String] the source code to format
|
2889
2890
|
# @return [String] formatted source
|
2890
2891
|
#
|
2891
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2892
|
+
# source://yard//lib/yard/code_objects/base.rb#599
|
2892
2893
|
def format_source(source); end
|
2893
2894
|
|
2894
|
-
# source://yard//lib/yard/code_objects/base.rb#
|
2895
|
+
# source://yard//lib/yard/code_objects/base.rb#606
|
2895
2896
|
def translate_docstring(locale); end
|
2896
2897
|
|
2897
2898
|
class << self
|
@@ -3264,11 +3265,11 @@ YARD::CodeObjects::METHODNAMEMATCH = T.let(T.unsafe(nil), Regexp)
|
|
3264
3265
|
# # Extra data added to docstring
|
3265
3266
|
# property :bar
|
3266
3267
|
#
|
3267
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3268
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#29
|
3268
3269
|
class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
3269
3270
|
# @return [Boolean] whether this macro is attached to a method
|
3270
3271
|
#
|
3271
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3272
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#148
|
3272
3273
|
def attached?; end
|
3273
3274
|
|
3274
3275
|
# Expands the macro using
|
@@ -3283,39 +3284,39 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3283
3284
|
# call, if there is a block.
|
3284
3285
|
# @see expand
|
3285
3286
|
#
|
3286
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3287
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#166
|
3287
3288
|
def expand(call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3288
3289
|
|
3289
3290
|
# @return [String] the macro data stored on the object
|
3290
3291
|
#
|
3291
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3292
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3292
3293
|
def macro_data; end
|
3293
3294
|
|
3294
3295
|
# @return [String] the macro data stored on the object
|
3295
3296
|
#
|
3296
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3297
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#141
|
3297
3298
|
def macro_data=(_arg0); end
|
3298
3299
|
|
3299
3300
|
# @return [CodeObjects::Base] the method object that this macro is
|
3300
3301
|
# attached to.
|
3301
3302
|
#
|
3302
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3303
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3303
3304
|
def method_object; end
|
3304
3305
|
|
3305
3306
|
# @return [CodeObjects::Base] the method object that this macro is
|
3306
3307
|
# attached to.
|
3307
3308
|
#
|
3308
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3309
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#145
|
3309
3310
|
def method_object=(_arg0); end
|
3310
3311
|
|
3311
3312
|
# Overrides {Base#path} so the macro path is ".macro.MACRONAME"
|
3312
3313
|
#
|
3313
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3314
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#151
|
3314
3315
|
def path; end
|
3315
3316
|
|
3316
3317
|
# Overrides the separator to be '.'
|
3317
3318
|
#
|
3318
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3319
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#154
|
3319
3320
|
def sep; end
|
3320
3321
|
|
3321
3322
|
class << self
|
@@ -3333,7 +3334,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3333
3334
|
# @return [String] the expanded macro data
|
3334
3335
|
# @see find_or_create
|
3335
3336
|
#
|
3336
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3337
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#119
|
3337
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
|
3338
3339
|
|
3339
3340
|
# Applies a macro to a docstring, interpolating the macro's data on the
|
@@ -3349,7 +3350,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3349
3350
|
# interpolating the block data as a variable.
|
3350
3351
|
# @return [String] the expanded macro data
|
3351
3352
|
#
|
3352
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3353
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#135
|
3353
3354
|
def apply_macro(macro, docstring, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3354
3355
|
|
3355
3356
|
# Creates a new macro and fills in the relevant properties.
|
@@ -3360,7 +3361,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3360
3361
|
# macro to. If supplied, {#attached?} will be true
|
3361
3362
|
# @return [MacroObject] the newly created object
|
3362
3363
|
#
|
3363
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3364
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#39
|
3364
3365
|
def create(macro_name, data, method_object = T.unsafe(nil)); end
|
3365
3366
|
|
3366
3367
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3380,7 +3381,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3380
3381
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3381
3382
|
# not new and no macro by the macro name is found.
|
3382
3383
|
#
|
3383
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3384
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3384
3385
|
def create_docstring(macro_name, data, method_object = T.unsafe(nil)); end
|
3385
3386
|
|
3386
3387
|
# Expands +macro_data+ using the interpolation parameters.
|
@@ -3393,7 +3394,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3393
3394
|
#
|
3394
3395
|
# @param macro_data [String] the macro data to expand (taken from {#macro_data})
|
3395
3396
|
#
|
3396
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3397
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#92
|
3397
3398
|
def expand(macro_data, call_params = T.unsafe(nil), full_source = T.unsafe(nil), block_source = T.unsafe(nil)); end
|
3398
3399
|
|
3399
3400
|
# Finds a macro using +macro_name+
|
@@ -3402,7 +3403,7 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3402
3403
|
# @return [MacroObject] if a macro is found
|
3403
3404
|
# @return [nil] if there is no registered macro by that name
|
3404
3405
|
#
|
3405
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3406
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#50
|
3406
3407
|
def find(macro_name); end
|
3407
3408
|
|
3408
3409
|
# Parses a given docstring and determines if the macro is "new" or
|
@@ -3422,12 +3423,12 @@ class YARD::CodeObjects::MacroObject < ::YARD::CodeObjects::Base
|
|
3422
3423
|
# @return [nil] if the +data+ has no macro tag or if the macro is
|
3423
3424
|
# not new and no macro by the macro name is found.
|
3424
3425
|
#
|
3425
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3426
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#70
|
3426
3427
|
def find_or_create(macro_name, data, method_object = T.unsafe(nil)); end
|
3427
3428
|
end
|
3428
3429
|
end
|
3429
3430
|
|
3430
|
-
# source://yard//lib/yard/code_objects/macro_object.rb#
|
3431
|
+
# source://yard//lib/yard/code_objects/macro_object.rb#30
|
3431
3432
|
YARD::CodeObjects::MacroObject::MACRO_MATCH = T.let(T.unsafe(nil), Regexp)
|
3432
3433
|
|
3433
3434
|
# Represents a Ruby method in source
|
@@ -4762,7 +4763,7 @@ YARD::Docstring::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
|
4762
4763
|
# @see #parse_content
|
4763
4764
|
# @since 0.8.0
|
4764
4765
|
#
|
4765
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4766
|
+
# source://yard//lib/yard/docstring_parser.rb#29
|
4766
4767
|
class YARD::DocstringParser
|
4767
4768
|
# Creates a new parser to parse docstring data
|
4768
4769
|
#
|
@@ -4771,7 +4772,7 @@ class YARD::DocstringParser
|
|
4771
4772
|
# @return [DocstringParser] a new instance of DocstringParser
|
4772
4773
|
# @since 0.8.0
|
4773
4774
|
#
|
4774
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4775
|
+
# source://yard//lib/yard/docstring_parser.rb#80
|
4775
4776
|
def initialize(library = T.unsafe(nil)); end
|
4776
4777
|
|
4777
4778
|
# Creates a new directive using the registered {#library}
|
@@ -4779,14 +4780,14 @@ class YARD::DocstringParser
|
|
4779
4780
|
# @return [Tags::Directive] the directive object that is created
|
4780
4781
|
# @since 0.8.0
|
4781
4782
|
#
|
4782
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4783
|
+
# source://yard//lib/yard/docstring_parser.rb#231
|
4783
4784
|
def create_directive(tag_name, tag_buf); end
|
4784
4785
|
|
4785
4786
|
# Creates a {Tags::RefTag}
|
4786
4787
|
#
|
4787
4788
|
# @since 0.8.0
|
4788
4789
|
#
|
4789
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4790
|
+
# source://yard//lib/yard/docstring_parser.rb#225
|
4790
4791
|
def create_ref_tag(tag_name, name, object_name); end
|
4791
4792
|
|
4792
4793
|
# Creates a tag from the {Tags::DefaultFactory tag factory}.
|
@@ -4798,7 +4799,7 @@ class YARD::DocstringParser
|
|
4798
4799
|
# @return [Tags::Tag, Tags::RefTag] a tag
|
4799
4800
|
# @since 0.8.0
|
4800
4801
|
#
|
4801
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4802
|
+
# source://yard//lib/yard/docstring_parser.rb#208
|
4802
4803
|
def create_tag(tag_name, tag_buf = T.unsafe(nil)); end
|
4803
4804
|
|
4804
4805
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4806,7 +4807,7 @@ class YARD::DocstringParser
|
|
4806
4807
|
# Docstring object.
|
4807
4808
|
# @since 0.8.0
|
4808
4809
|
#
|
4809
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4810
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4810
4811
|
def directives; end
|
4811
4812
|
|
4812
4813
|
# @return [Array<Tags::Directive>] a list of directives identified
|
@@ -4814,7 +4815,7 @@ class YARD::DocstringParser
|
|
4814
4815
|
# Docstring object.
|
4815
4816
|
# @since 0.8.0
|
4816
4817
|
#
|
4817
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4818
|
+
# source://yard//lib/yard/docstring_parser.rb#44
|
4818
4819
|
def directives=(_arg0); end
|
4819
4820
|
|
4820
4821
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4822,7 +4823,7 @@ class YARD::DocstringParser
|
|
4822
4823
|
# initialized through
|
4823
4824
|
# @since 0.8.0
|
4824
4825
|
#
|
4825
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4826
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4826
4827
|
def handler; end
|
4827
4828
|
|
4828
4829
|
# @return [Handlers::Base, nil] the handler parsing this
|
@@ -4830,21 +4831,21 @@ class YARD::DocstringParser
|
|
4830
4831
|
# initialized through
|
4831
4832
|
# @since 0.8.0
|
4832
4833
|
#
|
4833
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4834
|
+
# source://yard//lib/yard/docstring_parser.rb#65
|
4834
4835
|
def handler=(_arg0); end
|
4835
4836
|
|
4836
4837
|
# @return [Tags::Library] the tag library being used to
|
4837
4838
|
# identify registered tags in the docstring.
|
4838
4839
|
# @since 0.8.0
|
4839
4840
|
#
|
4840
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4841
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4841
4842
|
def library; end
|
4842
4843
|
|
4843
4844
|
# @return [Tags::Library] the tag library being used to
|
4844
4845
|
# identify registered tags in the docstring.
|
4845
4846
|
# @since 0.8.0
|
4846
4847
|
#
|
4847
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4848
|
+
# source://yard//lib/yard/docstring_parser.rb#69
|
4848
4849
|
def library=(_arg0); end
|
4849
4850
|
|
4850
4851
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4852,7 +4853,7 @@ class YARD::DocstringParser
|
|
4852
4853
|
# not attached to any object.
|
4853
4854
|
# @since 0.8.0
|
4854
4855
|
#
|
4855
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4856
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4856
4857
|
def object; end
|
4857
4858
|
|
4858
4859
|
# @return [CodeObjects::Base, nil] the object associated with
|
@@ -4860,7 +4861,7 @@ class YARD::DocstringParser
|
|
4860
4861
|
# not attached to any object.
|
4861
4862
|
# @since 0.8.0
|
4862
4863
|
#
|
4863
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4864
|
+
# source://yard//lib/yard/docstring_parser.rb#55
|
4864
4865
|
def object=(_arg0); end
|
4865
4866
|
|
4866
4867
|
# Parses all content and returns itself.
|
@@ -4877,7 +4878,7 @@ class YARD::DocstringParser
|
|
4877
4878
|
# @see #to_docstring
|
4878
4879
|
# @since 0.8.0
|
4879
4880
|
#
|
4880
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4881
|
+
# source://yard//lib/yard/docstring_parser.rb#112
|
4881
4882
|
def parse(content, object = T.unsafe(nil), handler = T.unsafe(nil)); end
|
4882
4883
|
|
4883
4884
|
# Parses a given block of text.
|
@@ -4887,7 +4888,7 @@ class YARD::DocstringParser
|
|
4887
4888
|
# @param content [String] the content to parse
|
4888
4889
|
# @since 0.8.0
|
4889
4890
|
#
|
4890
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4891
|
+
# source://yard//lib/yard/docstring_parser.rb#128
|
4891
4892
|
def parse_content(content); end
|
4892
4893
|
|
4893
4894
|
# Call post processing callbacks on parser.
|
@@ -4897,19 +4898,19 @@ class YARD::DocstringParser
|
|
4897
4898
|
# @return [void]
|
4898
4899
|
# @since 0.8.0
|
4899
4900
|
#
|
4900
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4901
|
+
# source://yard//lib/yard/docstring_parser.rb#195
|
4901
4902
|
def post_process; end
|
4902
4903
|
|
4903
4904
|
# @return [String] the complete input string to the parser.
|
4904
4905
|
# @since 0.8.0
|
4905
4906
|
#
|
4906
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4907
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4907
4908
|
def raw_text; end
|
4908
4909
|
|
4909
4910
|
# @return [String] the complete input string to the parser.
|
4910
4911
|
# @since 0.8.0
|
4911
4912
|
#
|
4912
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4913
|
+
# source://yard//lib/yard/docstring_parser.rb#35
|
4913
4914
|
def raw_text=(_arg0); end
|
4914
4915
|
|
4915
4916
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4917,7 +4918,7 @@ class YARD::DocstringParser
|
|
4917
4918
|
# refer to any object.
|
4918
4919
|
# @since 0.8.0
|
4919
4920
|
#
|
4920
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4921
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4921
4922
|
def reference; end
|
4922
4923
|
|
4923
4924
|
# @return [CodeObjects::Base, nil] the object referenced by
|
@@ -4925,7 +4926,7 @@ class YARD::DocstringParser
|
|
4925
4926
|
# refer to any object.
|
4926
4927
|
# @since 0.8.0
|
4927
4928
|
#
|
4928
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4929
|
+
# source://yard//lib/yard/docstring_parser.rb#60
|
4929
4930
|
def reference=(_arg0); end
|
4930
4931
|
|
4931
4932
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4934,7 +4935,7 @@ class YARD::DocstringParser
|
|
4934
4935
|
# used in a docstring).
|
4935
4936
|
# @since 0.8.0
|
4936
4937
|
#
|
4937
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4938
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4938
4939
|
def state; end
|
4939
4940
|
|
4940
4941
|
# @return [OpenStruct] any arbitrary state to be passed between
|
@@ -4943,7 +4944,7 @@ class YARD::DocstringParser
|
|
4943
4944
|
# used in a docstring).
|
4944
4945
|
# @since 0.8.0
|
4945
4946
|
#
|
4946
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4947
|
+
# source://yard//lib/yard/docstring_parser.rb#50
|
4947
4948
|
def state=(_arg0); end
|
4948
4949
|
|
4949
4950
|
# Backward compatibility to detect old tags that should be specified
|
@@ -4952,42 +4953,42 @@ class YARD::DocstringParser
|
|
4952
4953
|
# @return [Boolean]
|
4953
4954
|
# @since 0.8.0
|
4954
4955
|
#
|
4955
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4956
|
+
# source://yard//lib/yard/docstring_parser.rb#251
|
4956
4957
|
def tag_is_directive?(tag_name); end
|
4957
4958
|
|
4958
4959
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4959
4960
|
# by the parser
|
4960
4961
|
# @since 0.8.0
|
4961
4962
|
#
|
4962
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4963
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4963
4964
|
def tags; end
|
4964
4965
|
|
4965
4966
|
# @return [Array<Tags::Tag>] the list of meta-data tags identified
|
4966
4967
|
# by the parser
|
4967
4968
|
# @since 0.8.0
|
4968
4969
|
#
|
4969
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4970
|
+
# source://yard//lib/yard/docstring_parser.rb#39
|
4970
4971
|
def tags=(_arg0); end
|
4971
4972
|
|
4972
4973
|
# @return [String] the parsed text portion of the docstring,
|
4973
4974
|
# with tags removed.
|
4974
4975
|
# @since 0.8.0
|
4975
4976
|
#
|
4976
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4977
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4977
4978
|
def text; end
|
4978
4979
|
|
4979
4980
|
# @return [String] the parsed text portion of the docstring,
|
4980
4981
|
# with tags removed.
|
4981
4982
|
# @since 0.8.0
|
4982
4983
|
#
|
4983
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4984
|
+
# source://yard//lib/yard/docstring_parser.rb#32
|
4984
4985
|
def text=(_arg0); end
|
4985
4986
|
|
4986
4987
|
# @return [Docstring] translates parsed text into
|
4987
4988
|
# a Docstring object.
|
4988
4989
|
# @since 0.8.0
|
4989
4990
|
#
|
4990
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
4991
|
+
# source://yard//lib/yard/docstring_parser.rb#94
|
4991
4992
|
def to_docstring; end
|
4992
4993
|
|
4993
4994
|
private
|
@@ -4996,7 +4997,7 @@ class YARD::DocstringParser
|
|
4996
4997
|
#
|
4997
4998
|
# @since 0.8.0
|
4998
4999
|
#
|
4999
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5000
|
+
# source://yard//lib/yard/docstring_parser.rb#323
|
5000
5001
|
def call_after_parse_callbacks; end
|
5001
5002
|
|
5002
5003
|
# Calls the {Tags::Directive#after_parse} callback on all the
|
@@ -5004,17 +5005,17 @@ class YARD::DocstringParser
|
|
5004
5005
|
#
|
5005
5006
|
# @since 0.8.0
|
5006
5007
|
#
|
5007
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5008
|
+
# source://yard//lib/yard/docstring_parser.rb#318
|
5008
5009
|
def call_directives_after_parse; end
|
5009
5010
|
|
5010
5011
|
# @since 0.8.0
|
5011
5012
|
#
|
5012
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5013
|
+
# source://yard//lib/yard/docstring_parser.rb#304
|
5013
5014
|
def detect_reference(content); end
|
5014
5015
|
|
5015
5016
|
# @since 0.8.0
|
5016
5017
|
#
|
5017
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5018
|
+
# source://yard//lib/yard/docstring_parser.rb#300
|
5018
5019
|
def namespace; end
|
5019
5020
|
|
5020
5021
|
class << self
|
@@ -5029,13 +5030,13 @@ class YARD::DocstringParser
|
|
5029
5030
|
# with all directives and tags created.
|
5030
5031
|
# @yieldreturn [void]
|
5031
5032
|
#
|
5032
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5033
|
+
# source://yard//lib/yard/docstring_parser.rb#265
|
5033
5034
|
def after_parse(&block); end
|
5034
5035
|
|
5035
5036
|
# @return [Array<Proc>] the {after_parse} callback proc objects
|
5036
5037
|
# @since 0.8.0
|
5037
5038
|
#
|
5038
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5039
|
+
# source://yard//lib/yard/docstring_parser.rb#270
|
5039
5040
|
def after_parse_callbacks; end
|
5040
5041
|
end
|
5041
5042
|
end
|
@@ -5044,7 +5045,7 @@ end
|
|
5044
5045
|
#
|
5045
5046
|
# @since 0.8.0
|
5046
5047
|
#
|
5047
|
-
# source://yard//lib/yard/docstring_parser.rb#
|
5048
|
+
# source://yard//lib/yard/docstring_parser.rb#72
|
5048
5049
|
YARD::DocstringParser::META_MATCH = T.let(T.unsafe(nil), Regexp)
|
5049
5050
|
|
5050
5051
|
# source://yard//lib/yard/gem_index.rb#6
|
@@ -5953,14 +5954,14 @@ end
|
|
5953
5954
|
#
|
5954
5955
|
# @see Handlers::Base
|
5955
5956
|
#
|
5956
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5957
|
+
# source://yard//lib/yard/handlers/processor.rb#19
|
5957
5958
|
class YARD::Handlers::Processor
|
5958
5959
|
# Creates a new Processor for a +file+.
|
5959
5960
|
#
|
5960
5961
|
# @param parser [Parser::SourceParser] the parser used to initialize the processor
|
5961
5962
|
# @return [Processor] a new instance of Processor
|
5962
5963
|
#
|
5963
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5964
|
+
# source://yard//lib/yard/handlers/processor.rb#91
|
5964
5965
|
def initialize(parser); end
|
5965
5966
|
|
5966
5967
|
# Share state across different handlers inside of a file.
|
@@ -5973,7 +5974,7 @@ class YARD::Handlers::Processor
|
|
5973
5974
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5974
5975
|
# @see #globals
|
5975
5976
|
#
|
5976
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5977
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5977
5978
|
def extra_state; end
|
5978
5979
|
|
5979
5980
|
# Share state across different handlers inside of a file.
|
@@ -5986,17 +5987,17 @@ class YARD::Handlers::Processor
|
|
5986
5987
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
5987
5988
|
# @see #globals
|
5988
5989
|
#
|
5989
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5990
|
+
# source://yard//lib/yard/handlers/processor.rb#87
|
5990
5991
|
def extra_state=(_arg0); end
|
5991
5992
|
|
5992
5993
|
# @return [String] the filename
|
5993
5994
|
#
|
5994
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
5995
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
5995
5996
|
def file; end
|
5996
5997
|
|
5997
5998
|
# @return [String] the filename
|
5998
5999
|
#
|
5999
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6000
|
+
# source://yard//lib/yard/handlers/processor.rb#40
|
6000
6001
|
def file=(_arg0); end
|
6001
6002
|
|
6002
6003
|
# Searches for all handlers in {Base.subclasses} that match the +statement+
|
@@ -6004,7 +6005,7 @@ class YARD::Handlers::Processor
|
|
6004
6005
|
# @param statement the statement object to match.
|
6005
6006
|
# @return [Array<Base>] a list of handlers to process the statement with.
|
6006
6007
|
#
|
6007
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6008
|
+
# source://yard//lib/yard/handlers/processor.rb#150
|
6008
6009
|
def find_handlers(statement); end
|
6009
6010
|
|
6010
6011
|
# Handlers can share state for the entire post processing stage through
|
@@ -6024,7 +6025,7 @@ class YARD::Handlers::Processor
|
|
6024
6025
|
# @return [OpenStruct] global shared state for post-processing stage
|
6025
6026
|
# @see #extra_state
|
6026
6027
|
#
|
6027
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6028
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6028
6029
|
def globals; end
|
6029
6030
|
|
6030
6031
|
# Handlers can share state for the entire post processing stage through
|
@@ -6044,17 +6045,17 @@ class YARD::Handlers::Processor
|
|
6044
6045
|
# @return [OpenStruct] global shared state for post-processing stage
|
6045
6046
|
# @see #extra_state
|
6046
6047
|
#
|
6047
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6048
|
+
# source://yard//lib/yard/handlers/processor.rb#76
|
6048
6049
|
def globals=(_arg0); end
|
6049
6050
|
|
6050
6051
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6051
6052
|
#
|
6052
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6053
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6053
6054
|
def namespace; end
|
6054
6055
|
|
6055
6056
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
6056
6057
|
#
|
6057
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6058
|
+
# source://yard//lib/yard/handlers/processor.rb#43
|
6058
6059
|
def namespace=(_arg0); end
|
6059
6060
|
|
6060
6061
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6062,7 +6063,7 @@ class YARD::Handlers::Processor
|
|
6062
6063
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6063
6064
|
# is set as the owner, in case any extra method information is processed.
|
6064
6065
|
#
|
6065
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6066
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6066
6067
|
def owner; end
|
6067
6068
|
|
6068
6069
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
@@ -6070,7 +6071,7 @@ class YARD::Handlers::Processor
|
|
6070
6071
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
6071
6072
|
# is set as the owner, in case any extra method information is processed.
|
6072
6073
|
#
|
6073
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6074
|
+
# source://yard//lib/yard/handlers/processor.rb#55
|
6074
6075
|
def owner=(_arg0); end
|
6075
6076
|
|
6076
6077
|
# Continue parsing the remainder of the files in the +globals.ordered_parser+
|
@@ -6080,17 +6081,17 @@ class YARD::Handlers::Processor
|
|
6080
6081
|
# @return [void]
|
6081
6082
|
# @see Parser::OrderedParser
|
6082
6083
|
#
|
6083
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6084
|
+
# source://yard//lib/yard/handlers/processor.rb#139
|
6084
6085
|
def parse_remaining_files; end
|
6085
6086
|
|
6086
6087
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6087
6088
|
#
|
6088
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6089
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6089
6090
|
def parser_type; end
|
6090
6091
|
|
6091
6092
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
6092
6093
|
#
|
6093
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6094
|
+
# source://yard//lib/yard/handlers/processor.rb#58
|
6094
6095
|
def parser_type=(_arg0); end
|
6095
6096
|
|
6096
6097
|
# Processes a list of statements by finding handlers to process each
|
@@ -6099,27 +6100,27 @@ class YARD::Handlers::Processor
|
|
6099
6100
|
# @param statements [Array] a list of statements
|
6100
6101
|
# @return [void]
|
6101
6102
|
#
|
6102
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6103
|
+
# source://yard//lib/yard/handlers/processor.rb#109
|
6103
6104
|
def process(statements); end
|
6104
6105
|
|
6105
6106
|
# @return [Symbol] the current scope (class, instance)
|
6106
6107
|
#
|
6107
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6108
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6108
6109
|
def scope; end
|
6109
6110
|
|
6110
6111
|
# @return [Symbol] the current scope (class, instance)
|
6111
6112
|
#
|
6112
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6113
|
+
# source://yard//lib/yard/handlers/processor.rb#49
|
6113
6114
|
def scope=(_arg0); end
|
6114
6115
|
|
6115
6116
|
# @return [Symbol] the current visibility (public, private, protected)
|
6116
6117
|
#
|
6117
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6118
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6118
6119
|
def visibility; end
|
6119
6120
|
|
6120
6121
|
# @return [Symbol] the current visibility (public, private, protected)
|
6121
6122
|
#
|
6122
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6123
|
+
# source://yard//lib/yard/handlers/processor.rb#46
|
6123
6124
|
def visibility=(_arg0); end
|
6124
6125
|
|
6125
6126
|
private
|
@@ -6128,7 +6129,7 @@ class YARD::Handlers::Processor
|
|
6128
6129
|
#
|
6129
6130
|
# @return [Base] the base class
|
6130
6131
|
#
|
6131
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6132
|
+
# source://yard//lib/yard/handlers/processor.rb#171
|
6132
6133
|
def handler_base_class; end
|
6133
6134
|
|
6134
6135
|
# The module holding the handlers to be loaded
|
@@ -6136,12 +6137,12 @@ class YARD::Handlers::Processor
|
|
6136
6137
|
# @return [Module] the module containing the handlers depending on
|
6137
6138
|
# {#parser_type}.
|
6138
6139
|
#
|
6139
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6140
|
+
# source://yard//lib/yard/handlers/processor.rb#179
|
6140
6141
|
def handler_base_namespace; end
|
6141
6142
|
|
6142
6143
|
# @return [Boolean]
|
6143
6144
|
#
|
6144
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6145
|
+
# source://yard//lib/yard/handlers/processor.rb#160
|
6145
6146
|
def handles?(handler, statement); end
|
6146
6147
|
|
6147
6148
|
# Loads handlers from {#handler_base_namespace}. This ensures that
|
@@ -6150,7 +6151,7 @@ class YARD::Handlers::Processor
|
|
6150
6151
|
#
|
6151
6152
|
# @return [void]
|
6152
6153
|
#
|
6153
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6154
|
+
# source://yard//lib/yard/handlers/processor.rb#187
|
6154
6155
|
def load_handlers; end
|
6155
6156
|
|
6156
6157
|
class << self
|
@@ -6158,14 +6159,14 @@ class YARD::Handlers::Processor
|
|
6158
6159
|
# @return [Hash] a list of registered parser type extensions
|
6159
6160
|
# @since 0.6.0
|
6160
6161
|
#
|
6161
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6162
|
+
# source://yard//lib/yard/handlers/processor.rb#32
|
6162
6163
|
def namespace_for_handler; end
|
6163
6164
|
|
6164
6165
|
# Registers a new namespace for handlers of the given type.
|
6165
6166
|
#
|
6166
6167
|
# @since 0.6.0
|
6167
6168
|
#
|
6168
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
6169
|
+
# source://yard//lib/yard/handlers/processor.rb#23
|
6169
6170
|
def register_handler_namespace(type, ns); end
|
6170
6171
|
end
|
6171
6172
|
end
|
@@ -6998,6 +6999,11 @@ end
|
|
6998
6999
|
# source://yard//lib/yard/handlers/ruby/visibility_handler.rb#3
|
6999
7000
|
class YARD::Handlers::Ruby::VisibilityHandler < ::YARD::Handlers::Ruby::Base
|
7000
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
|
7001
7007
|
end
|
7002
7008
|
|
7003
7009
|
# Handles 'yield' calls
|
@@ -7460,13 +7466,16 @@ end
|
|
7460
7466
|
# Handles console logging for info, warnings and errors.
|
7461
7467
|
# Uses the stdlib Logger class in Ruby for all the backend logic.
|
7462
7468
|
#
|
7463
|
-
# source://yard//lib/yard/logging.rb#
|
7464
|
-
class YARD::Logger
|
7469
|
+
# source://yard//lib/yard/logging.rb#8
|
7470
|
+
class YARD::Logger
|
7471
|
+
include ::YARD::Logger::Severity
|
7472
|
+
|
7465
7473
|
# Creates a new logger
|
7466
7474
|
#
|
7475
|
+
# @private
|
7467
7476
|
# @return [Logger] a new instance of Logger
|
7468
7477
|
#
|
7469
|
-
# source://yard//lib/yard/logging.rb#
|
7478
|
+
# source://yard//lib/yard/logging.rb#82
|
7470
7479
|
def initialize(pipe, *args); end
|
7471
7480
|
|
7472
7481
|
# Displays an unformatted line to the logger output stream.
|
@@ -7475,7 +7484,7 @@ class YARD::Logger < ::Logger
|
|
7475
7484
|
# @return [void]
|
7476
7485
|
# @since 0.8.2
|
7477
7486
|
#
|
7478
|
-
# source://yard//lib/yard/logging.rb#
|
7487
|
+
# source://yard//lib/yard/logging.rb#205
|
7479
7488
|
def <<(msg = T.unsafe(nil)); end
|
7480
7489
|
|
7481
7490
|
# Prints the backtrace +exc+ to the logger as error data.
|
@@ -7484,7 +7493,7 @@ class YARD::Logger < ::Logger
|
|
7484
7493
|
# @param level_meth [Symbol] the level to log backtrace at
|
7485
7494
|
# @return [void]
|
7486
7495
|
#
|
7487
|
-
# source://yard//lib/yard/logging.rb#
|
7496
|
+
# source://yard//lib/yard/logging.rb#216
|
7488
7497
|
def backtrace(exc, level_meth = T.unsafe(nil)); end
|
7489
7498
|
|
7490
7499
|
# Captures the duration of a block of code for benchmark analysis. Also
|
@@ -7497,7 +7506,7 @@ class YARD::Logger < ::Logger
|
|
7497
7506
|
# @todo Implement capture storage for reporting of benchmarks
|
7498
7507
|
# @yield a block of arbitrary code to benchmark
|
7499
7508
|
#
|
7500
|
-
# source://yard//lib/yard/logging.rb#
|
7509
|
+
# source://yard//lib/yard/logging.rb#234
|
7501
7510
|
def capture(msg, nontty_log = T.unsafe(nil)); end
|
7502
7511
|
|
7503
7512
|
# Clears the progress indicator in the TTY display.
|
@@ -7505,14 +7514,18 @@ class YARD::Logger < ::Logger
|
|
7505
7514
|
# @return [void]
|
7506
7515
|
# @since 0.8.2
|
7507
7516
|
#
|
7508
|
-
# source://yard//lib/yard/logging.rb#
|
7517
|
+
# source://yard//lib/yard/logging.rb#186
|
7509
7518
|
def clear_progress; end
|
7510
7519
|
|
7511
|
-
# Changes the debug level to DEBUG if $DEBUG is set
|
7512
|
-
#
|
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
|
7513
7526
|
#
|
7514
|
-
# source://yard//lib/yard/logging.rb#
|
7515
|
-
def debug(
|
7527
|
+
# source://yard//lib/yard/logging.rb#103
|
7528
|
+
def debug(message); end
|
7516
7529
|
|
7517
7530
|
# Sets the logger level for the duration of the block
|
7518
7531
|
#
|
@@ -7524,17 +7537,65 @@ class YARD::Logger < ::Logger
|
|
7524
7537
|
# values can be found in Ruby's Logger class.
|
7525
7538
|
# @yield the block with the logger temporarily set to +new_level+
|
7526
7539
|
#
|
7527
|
-
# source://yard//lib/yard/logging.rb#
|
7540
|
+
# source://yard//lib/yard/logging.rb#142
|
7528
7541
|
def enter_level(new_level = T.unsafe(nil)); end
|
7529
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
|
+
|
7530
7570
|
# @return [IO] the IO object being logged to
|
7531
7571
|
# @since 0.8.2
|
7532
7572
|
#
|
7533
|
-
# source://yard//lib/yard/logging.rb#
|
7573
|
+
# source://yard//lib/yard/logging.rb#49
|
7534
7574
|
def io; end
|
7535
7575
|
|
7536
|
-
#
|
7537
|
-
|
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
|
7538
7599
|
|
7539
7600
|
# Displays an unformatted line to the logger output stream.
|
7540
7601
|
#
|
@@ -7542,7 +7603,7 @@ class YARD::Logger < ::Logger
|
|
7542
7603
|
# @return [void]
|
7543
7604
|
# @since 0.8.2
|
7544
7605
|
#
|
7545
|
-
# source://yard//lib/yard/logging.rb#
|
7606
|
+
# source://yard//lib/yard/logging.rb#205
|
7546
7607
|
def print(msg = T.unsafe(nil)); end
|
7547
7608
|
|
7548
7609
|
# Displays a progress indicator for a given message. This progress report
|
@@ -7555,7 +7616,7 @@ class YARD::Logger < ::Logger
|
|
7555
7616
|
# @return [void]
|
7556
7617
|
# @since 0.8.2
|
7557
7618
|
#
|
7558
|
-
# source://yard//lib/yard/logging.rb#
|
7619
|
+
# source://yard//lib/yard/logging.rb#161
|
7559
7620
|
def progress(msg, nontty_log = T.unsafe(nil)); end
|
7560
7621
|
|
7561
7622
|
# Displays an unformatted line to the logger output stream, adding
|
@@ -7565,86 +7626,91 @@ class YARD::Logger < ::Logger
|
|
7565
7626
|
# @return [void]
|
7566
7627
|
# @since 0.8.2
|
7567
7628
|
#
|
7568
|
-
# source://yard//lib/yard/logging.rb#
|
7629
|
+
# source://yard//lib/yard/logging.rb#197
|
7569
7630
|
def puts(msg = T.unsafe(nil)); end
|
7570
7631
|
|
7571
7632
|
# @return [Boolean] whether backtraces should be shown (by default
|
7572
7633
|
# this is on).
|
7573
7634
|
#
|
7574
|
-
# source://yard//lib/yard/logging.rb#
|
7635
|
+
# source://yard//lib/yard/logging.rb#53
|
7575
7636
|
def show_backtraces; end
|
7576
7637
|
|
7577
7638
|
# Sets the attribute show_backtraces
|
7578
7639
|
#
|
7579
7640
|
# @param value the value to set the attribute show_backtraces to.
|
7580
7641
|
#
|
7581
|
-
# source://yard//lib/yard/logging.rb#
|
7642
|
+
# source://yard//lib/yard/logging.rb#54
|
7582
7643
|
def show_backtraces=(_arg0); end
|
7583
7644
|
|
7584
7645
|
# @return [Boolean] whether progress indicators should be shown when
|
7585
7646
|
# logging CLIs (by default this is off).
|
7586
7647
|
#
|
7587
|
-
# source://yard//lib/yard/logging.rb#
|
7648
|
+
# source://yard//lib/yard/logging.rb#64
|
7588
7649
|
def show_progress; end
|
7589
7650
|
|
7590
7651
|
# Sets the attribute show_progress
|
7591
7652
|
#
|
7592
7653
|
# @param value the value to set the attribute show_progress to.
|
7593
7654
|
#
|
7594
|
-
# source://yard//lib/yard/logging.rb#
|
7655
|
+
# source://yard//lib/yard/logging.rb#70
|
7595
7656
|
def show_progress=(_arg0); end
|
7596
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
|
+
|
7597
7667
|
# Remembers when a warning occurs and writes a warning message.
|
7668
|
+
# Logs a message with the warn severity level.
|
7598
7669
|
#
|
7599
|
-
#
|
7600
|
-
|
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
|
7601
7676
|
|
7602
7677
|
# Warns that the Ruby environment does not support continuations. Applies
|
7603
7678
|
# to JRuby, Rubinius and MacRuby. This warning will only display once
|
7604
7679
|
# per Ruby process.
|
7605
7680
|
#
|
7606
7681
|
# @deprecated Continuations are no longer needed by YARD 0.8.0+.
|
7682
|
+
# @private
|
7607
7683
|
# @return [void]
|
7608
7684
|
#
|
7609
|
-
# source://yard//lib/yard/logging.rb#
|
7685
|
+
# source://yard//lib/yard/logging.rb#250
|
7610
7686
|
def warn_no_continuations; end
|
7611
7687
|
|
7612
|
-
#
|
7688
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7613
7689
|
#
|
7614
|
-
# source://yard//lib/yard/logging.rb#
|
7690
|
+
# source://yard//lib/yard/logging.rb#60
|
7615
7691
|
def warned; end
|
7616
7692
|
|
7617
|
-
#
|
7693
|
+
# @return [Boolean] whether a warn message has been emitted. Used for status tracking.
|
7618
7694
|
#
|
7619
|
-
#
|
7620
|
-
#
|
7621
|
-
# source://yard//lib/yard/logging.rb#69
|
7695
|
+
# source://yard//lib/yard/logging.rb#60
|
7622
7696
|
def warned=(_arg0); end
|
7623
7697
|
|
7624
7698
|
private
|
7625
7699
|
|
7626
|
-
#
|
7627
|
-
#
|
7628
|
-
# source://yard//lib/yard/logging.rb#190
|
7629
|
-
def add(*args); end
|
7630
|
-
|
7631
|
-
# source://yard//lib/yard/logging.rb#195
|
7700
|
+
# source://yard//lib/yard/logging.rb#255
|
7632
7701
|
def clear_line; end
|
7633
7702
|
|
7634
|
-
# Log format (from Logger implementation). Used by Logger internally
|
7635
|
-
#
|
7636
|
-
# source://yard//lib/yard/logging.rb#201
|
7637
|
-
def format_log(sev, _time, _prog, msg); end
|
7638
|
-
|
7639
|
-
# source://logger/1.6.1/lib/logger.rb#689
|
7640
|
-
def print_no_newline(msg); end
|
7641
|
-
|
7642
7703
|
class << self
|
7704
|
+
# @private
|
7705
|
+
#
|
7706
|
+
# source://yard//lib/yard/logging.rb#101
|
7707
|
+
def create_log_method(name); end
|
7708
|
+
|
7643
7709
|
# The logger instance
|
7644
7710
|
#
|
7645
7711
|
# @return [Logger] the logger instance
|
7646
7712
|
#
|
7647
|
-
# source://yard//lib/yard/logging.rb#
|
7713
|
+
# source://yard//lib/yard/logging.rb#76
|
7648
7714
|
def instance(pipe = T.unsafe(nil)); end
|
7649
7715
|
end
|
7650
7716
|
end
|
@@ -7654,9 +7720,97 @@ end
|
|
7654
7720
|
#
|
7655
7721
|
# @since 0.8.2
|
7656
7722
|
#
|
7657
|
-
# source://yard//lib/yard/logging.rb#
|
7723
|
+
# source://yard//lib/yard/logging.rb#45
|
7658
7724
|
YARD::Logger::PROGRESS_INDICATORS = T.let(T.unsafe(nil), Array)
|
7659
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
|
+
|
7660
7814
|
# Generalized options class for passing around large amounts of options between objects.
|
7661
7815
|
#
|
7662
7816
|
# The options class exists for better visibility and documentability of options being
|
@@ -8208,7 +8362,7 @@ end
|
|
8208
8362
|
#
|
8209
8363
|
# @see Processor#parse_remaining_files
|
8210
8364
|
#
|
8211
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8365
|
+
# source://yard//lib/yard/parser/source_parser.rb#20
|
8212
8366
|
class YARD::Parser::OrderedParser
|
8213
8367
|
# Creates a new OrderedParser with the global state and a list
|
8214
8368
|
# of files to parse.
|
@@ -8220,30 +8374,30 @@ class YARD::Parser::OrderedParser
|
|
8220
8374
|
# @param files [Array<String>] the list of files to parse
|
8221
8375
|
# @return [OrderedParser] a new instance of OrderedParser
|
8222
8376
|
#
|
8223
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8377
|
+
# source://yard//lib/yard/parser/source_parser.rb#32
|
8224
8378
|
def initialize(global_state, files); end
|
8225
8379
|
|
8226
8380
|
# @return [Array<String>] the list of remaining files to parse
|
8227
8381
|
#
|
8228
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8382
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8229
8383
|
def files; end
|
8230
8384
|
|
8231
8385
|
# @return [Array<String>] the list of remaining files to parse
|
8232
8386
|
#
|
8233
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8387
|
+
# source://yard//lib/yard/parser/source_parser.rb#22
|
8234
8388
|
def files=(_arg0); end
|
8235
8389
|
|
8236
8390
|
# Parses the remainder of the {#files} list.
|
8237
8391
|
#
|
8238
8392
|
# @see Processor#parse_remaining_files
|
8239
8393
|
#
|
8240
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8394
|
+
# source://yard//lib/yard/parser/source_parser.rb#41
|
8241
8395
|
def parse; end
|
8242
8396
|
end
|
8243
8397
|
|
8244
8398
|
# Raised when the parser sees a Ruby syntax error
|
8245
8399
|
#
|
8246
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
8400
|
+
# source://yard//lib/yard/parser/source_parser.rb#12
|
8247
8401
|
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
|
8248
8402
|
|
8249
8403
|
# Ruby parsing components.
|
@@ -8688,6 +8842,9 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8688
8842
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#430
|
8689
8843
|
def continue; end
|
8690
8844
|
|
8845
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1116
|
8846
|
+
def dedent(str); end
|
8847
|
+
|
8691
8848
|
# Returns the value of attribute exception_on_syntax_error.
|
8692
8849
|
#
|
8693
8850
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#463
|
@@ -8712,7 +8869,7 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8712
8869
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#488
|
8713
8870
|
def gets; end
|
8714
8871
|
|
8715
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8872
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1272
|
8716
8873
|
def identify_comment; end
|
8717
8874
|
|
8718
8875
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#945
|
@@ -8724,13 +8881,13 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8724
8881
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#980
|
8725
8882
|
def identify_identifier; end
|
8726
8883
|
|
8727
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8884
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1145
|
8728
8885
|
def identify_number(start); end
|
8729
8886
|
|
8730
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8887
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1126
|
8731
8888
|
def identify_quotation(initial_char); end
|
8732
8889
|
|
8733
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8890
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1207
|
8734
8891
|
def identify_string(ltype, quoted = T.unsafe(nil), opener = T.unsafe(nil), initial_char = T.unsafe(nil)); end
|
8735
8892
|
|
8736
8893
|
# Returns the value of attribute indent.
|
@@ -8777,10 +8934,10 @@ class YARD::Parser::Ruby::Legacy::RubyLex
|
|
8777
8934
|
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#462
|
8778
8935
|
def read_auto_clean_up=(_arg0); end
|
8779
8936
|
|
8780
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8937
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1295
|
8781
8938
|
def read_escape; end
|
8782
8939
|
|
8783
|
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#
|
8940
|
+
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#1257
|
8784
8941
|
def skip_inner_expression; end
|
8785
8942
|
|
8786
8943
|
# Returns the value of attribute skip_space.
|
@@ -10969,7 +11126,7 @@ end
|
|
10969
11126
|
# @see Handlers::Base
|
10970
11127
|
# @see CodeObjects::Base
|
10971
11128
|
#
|
10972
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11129
|
+
# source://yard//lib/yard/parser/source_parser.rb#63
|
10973
11130
|
class YARD::Parser::SourceParser
|
10974
11131
|
# @overload initialize
|
10975
11132
|
# @return [SourceParser] a new instance of SourceParser
|
@@ -11034,10 +11191,10 @@ class YARD::Parser::SourceParser
|
|
11034
11191
|
|
11035
11192
|
# @since 0.5.6
|
11036
11193
|
#
|
11037
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11194
|
+
# source://yard//lib/yard/parser/source_parser.rb#515
|
11038
11195
|
def parser_class; end
|
11039
11196
|
|
11040
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11197
|
+
# source://yard//lib/yard/parser/source_parser.rb#500
|
11041
11198
|
def parser_type=(value); end
|
11042
11199
|
|
11043
11200
|
# Guesses the parser type to use depending on the file extension.
|
@@ -11045,14 +11202,14 @@ class YARD::Parser::SourceParser
|
|
11045
11202
|
# @param filename [String] the filename to use to guess the parser type
|
11046
11203
|
# @return [Symbol] a parser type that matches the filename
|
11047
11204
|
#
|
11048
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11205
|
+
# source://yard//lib/yard/parser/source_parser.rb#508
|
11049
11206
|
def parser_type_for_filename(filename); end
|
11050
11207
|
|
11051
11208
|
# Runs a {Handlers::Processor} object to post process the parsed statements.
|
11052
11209
|
#
|
11053
11210
|
# @return [void]
|
11054
11211
|
#
|
11055
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11212
|
+
# source://yard//lib/yard/parser/source_parser.rb#490
|
11056
11213
|
def post_process; end
|
11057
11214
|
|
11058
11215
|
class << self
|
@@ -11225,7 +11382,7 @@ class YARD::Parser::SourceParser
|
|
11225
11382
|
# {YARD::Logger}
|
11226
11383
|
# @return [void]
|
11227
11384
|
#
|
11228
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11385
|
+
# source://yard//lib/yard/parser/source_parser.rb#99
|
11229
11386
|
def parse(paths = T.unsafe(nil), excluded = T.unsafe(nil), level = T.unsafe(nil)); end
|
11230
11387
|
|
11231
11388
|
# Parses a string +content+
|
@@ -11239,10 +11396,10 @@ class YARD::Parser::SourceParser
|
|
11239
11396
|
|
11240
11397
|
# @return [Symbol] the default parser type (defaults to :ruby)
|
11241
11398
|
#
|
11242
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11399
|
+
# source://yard//lib/yard/parser/source_parser.rb#85
|
11243
11400
|
def parser_type; end
|
11244
11401
|
|
11245
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11402
|
+
# source://yard//lib/yard/parser/source_parser.rb#87
|
11246
11403
|
def parser_type=(value); end
|
11247
11404
|
|
11248
11405
|
# @private
|
@@ -11323,30 +11480,30 @@ end
|
|
11323
11480
|
#
|
11324
11481
|
# @since 0.9.0
|
11325
11482
|
#
|
11326
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11483
|
+
# source://yard//lib/yard/parser/source_parser.rb#70
|
11327
11484
|
YARD::Parser::SourceParser::DEFAULT_PATH_GLOB = T.let(T.unsafe(nil), Array)
|
11328
11485
|
|
11329
11486
|
# Byte order marks for various encodings
|
11330
11487
|
#
|
11331
11488
|
# @since 0.7.0
|
11332
11489
|
#
|
11333
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11490
|
+
# source://yard//lib/yard/parser/source_parser.rb#74
|
11334
11491
|
YARD::Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS = T.let(T.unsafe(nil), Hash)
|
11335
11492
|
|
11336
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11493
|
+
# source://yard//lib/yard/parser/source_parser.rb#65
|
11337
11494
|
YARD::Parser::SourceParser::ENCODING_LINE = T.let(T.unsafe(nil), Regexp)
|
11338
11495
|
|
11339
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11496
|
+
# source://yard//lib/yard/parser/source_parser.rb#66
|
11340
11497
|
YARD::Parser::SourceParser::FROZEN_STRING_LINE = T.let(T.unsafe(nil), Regexp)
|
11341
11498
|
|
11342
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11499
|
+
# source://yard//lib/yard/parser/source_parser.rb#64
|
11343
11500
|
YARD::Parser::SourceParser::SHEBANG_LINE = T.let(T.unsafe(nil), Regexp)
|
11344
11501
|
|
11345
11502
|
# Raised when an object is recognized but cannot be documented. This
|
11346
11503
|
# generally occurs when the Ruby syntax used to declare an object is
|
11347
11504
|
# too dynamic in nature.
|
11348
11505
|
#
|
11349
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
11506
|
+
# source://yard//lib/yard/parser/source_parser.rb#9
|
11350
11507
|
class YARD::Parser::UndocumentableError < ::RuntimeError; end
|
11351
11508
|
|
11352
11509
|
# The root path for YARD source libraries
|
@@ -14621,42 +14778,42 @@ module YARD::Tags; end
|
|
14621
14778
|
# @see tag:!method
|
14622
14779
|
# @since 0.7.0
|
14623
14780
|
#
|
14624
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14781
|
+
# source://yard//lib/yard/tags/directives.rb#460
|
14625
14782
|
class YARD::Tags::AttributeDirective < ::YARD::Tags::MethodDirective
|
14626
14783
|
# @since 0.7.0
|
14627
14784
|
#
|
14628
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14785
|
+
# source://yard//lib/yard/tags/directives.rb#461
|
14629
14786
|
def after_parse; end
|
14630
14787
|
|
14631
14788
|
protected
|
14632
14789
|
|
14633
14790
|
# @since 0.7.0
|
14634
14791
|
#
|
14635
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14792
|
+
# source://yard//lib/yard/tags/directives.rb#469
|
14636
14793
|
def method_name; end
|
14637
14794
|
|
14638
14795
|
# @since 0.7.0
|
14639
14796
|
#
|
14640
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14797
|
+
# source://yard//lib/yard/tags/directives.rb#475
|
14641
14798
|
def method_signature; end
|
14642
14799
|
|
14643
14800
|
private
|
14644
14801
|
|
14645
14802
|
# @since 0.7.0
|
14646
14803
|
#
|
14647
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14804
|
+
# source://yard//lib/yard/tags/directives.rb#485
|
14648
14805
|
def create_attribute_data(object); end
|
14649
14806
|
|
14650
14807
|
# @return [Boolean]
|
14651
14808
|
# @since 0.7.0
|
14652
14809
|
#
|
14653
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14810
|
+
# source://yard//lib/yard/tags/directives.rb#515
|
14654
14811
|
def readable?; end
|
14655
14812
|
|
14656
14813
|
# @return [Boolean]
|
14657
14814
|
# @since 0.7.0
|
14658
14815
|
#
|
14659
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14816
|
+
# source://yard//lib/yard/tags/directives.rb#511
|
14660
14817
|
def writable?; end
|
14661
14818
|
end
|
14662
14819
|
|
@@ -14790,14 +14947,14 @@ end
|
|
14790
14947
|
# @see Library.define_directive
|
14791
14948
|
# @since 0.8.0
|
14792
14949
|
#
|
14793
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14950
|
+
# source://yard//lib/yard/tags/directives.rb#22
|
14794
14951
|
class YARD::Tags::Directive
|
14795
14952
|
# @param tag [Tag] the meta-data tag containing all input to the docstring
|
14796
14953
|
# @param parser [DocstringParser] the docstring parser object
|
14797
14954
|
# @return [Directive] a new instance of Directive
|
14798
14955
|
# @since 0.8.0
|
14799
14956
|
#
|
14800
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14957
|
+
# source://yard//lib/yard/tags/directives.rb#54
|
14801
14958
|
def initialize(tag, parser); end
|
14802
14959
|
|
14803
14960
|
# Called after parsing all directives and tags in the docstring. Used
|
@@ -14806,7 +14963,7 @@ class YARD::Tags::Directive
|
|
14806
14963
|
# @return [void]
|
14807
14964
|
# @since 0.8.0
|
14808
14965
|
#
|
14809
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14966
|
+
# source://yard//lib/yard/tags/directives.rb#73
|
14810
14967
|
def after_parse; end
|
14811
14968
|
|
14812
14969
|
# Called when processing the directive. Subclasses should implement
|
@@ -14818,7 +14975,7 @@ class YARD::Tags::Directive
|
|
14818
14975
|
# @return [void]
|
14819
14976
|
# @since 0.8.0
|
14820
14977
|
#
|
14821
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14978
|
+
# source://yard//lib/yard/tags/directives.rb#68
|
14822
14979
|
def call; end
|
14823
14980
|
|
14824
14981
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14830,7 +14987,7 @@ class YARD::Tags::Directive
|
|
14830
14987
|
# @return [nil] if no expansion should take place for this directive
|
14831
14988
|
# @since 0.8.0
|
14832
14989
|
#
|
14833
|
-
# source://yard//lib/yard/tags/directives.rb#
|
14990
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14834
14991
|
def expanded_text; end
|
14835
14992
|
|
14836
14993
|
# Set this field to replace the directive definition inside of a docstring
|
@@ -14842,7 +14999,7 @@ class YARD::Tags::Directive
|
|
14842
14999
|
# @return [nil] if no expansion should take place for this directive
|
14843
15000
|
# @since 0.8.0
|
14844
15001
|
#
|
14845
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15002
|
+
# source://yard//lib/yard/tags/directives.rb#33
|
14846
15003
|
def expanded_text=(_arg0); end
|
14847
15004
|
|
14848
15005
|
# @return [Handlers::Base, nil] the handler object the docstring parser
|
@@ -14850,33 +15007,33 @@ class YARD::Tags::Directive
|
|
14850
15007
|
# through {Parser::SourceParser}.
|
14851
15008
|
# @since 0.8.0
|
14852
15009
|
#
|
14853
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15010
|
+
# source://yard//lib/yard/tags/directives.rb#48
|
14854
15011
|
def handler; end
|
14855
15012
|
|
14856
15013
|
# @return [CodeObjects::Base, nil] the object the parent docstring is
|
14857
15014
|
# attached to. May be nil.
|
14858
15015
|
# @since 0.8.0
|
14859
15016
|
#
|
14860
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15017
|
+
# source://yard//lib/yard/tags/directives.rb#42
|
14861
15018
|
def object; end
|
14862
15019
|
|
14863
15020
|
# @return [DocstringParser] the parser that is parsing all tag
|
14864
15021
|
# information out of the docstring
|
14865
15022
|
# @since 0.8.0
|
14866
15023
|
#
|
14867
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15024
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14868
15025
|
def parser=(_arg0); end
|
14869
15026
|
|
14870
15027
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14871
15028
|
# @since 0.8.0
|
14872
15029
|
#
|
14873
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15030
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14874
15031
|
def tag; end
|
14875
15032
|
|
14876
15033
|
# @return [Tag] the meta-data tag containing data input to the directive
|
14877
15034
|
# @since 0.8.0
|
14878
15035
|
#
|
14879
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15036
|
+
# source://yard//lib/yard/tags/directives.rb#24
|
14880
15037
|
def tag=(_arg0); end
|
14881
15038
|
|
14882
15039
|
protected
|
@@ -14884,14 +15041,14 @@ class YARD::Tags::Directive
|
|
14884
15041
|
# @return [Boolean]
|
14885
15042
|
# @since 0.8.0
|
14886
15043
|
#
|
14887
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15044
|
+
# source://yard//lib/yard/tags/directives.rb#79
|
14888
15045
|
def inside_directive?; end
|
14889
15046
|
|
14890
15047
|
# @return [DocstringParser] the parser that is parsing all tag
|
14891
15048
|
# information out of the docstring
|
14892
15049
|
# @since 0.8.0
|
14893
15050
|
#
|
14894
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15051
|
+
# source://yard//lib/yard/tags/directives.rb#37
|
14895
15052
|
def parser; end
|
14896
15053
|
end
|
14897
15054
|
|
@@ -14915,11 +15072,11 @@ end
|
|
14915
15072
|
# @see tag:!group
|
14916
15073
|
# @since 0.6.0
|
14917
15074
|
#
|
14918
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15075
|
+
# source://yard//lib/yard/tags/directives.rb#104
|
14919
15076
|
class YARD::Tags::EndGroupDirective < ::YARD::Tags::Directive
|
14920
15077
|
# @since 0.6.0
|
14921
15078
|
#
|
14922
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15079
|
+
# source://yard//lib/yard/tags/directives.rb#105
|
14923
15080
|
def call; end
|
14924
15081
|
end
|
14925
15082
|
|
@@ -14940,11 +15097,11 @@ end
|
|
14940
15097
|
# @see tag:!endgroup
|
14941
15098
|
# @since 0.6.0
|
14942
15099
|
#
|
14943
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15100
|
+
# source://yard//lib/yard/tags/directives.rb#127
|
14944
15101
|
class YARD::Tags::GroupDirective < ::YARD::Tags::Directive
|
14945
15102
|
# @since 0.6.0
|
14946
15103
|
#
|
14947
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15104
|
+
# source://yard//lib/yard/tags/directives.rb#128
|
14948
15105
|
def call; end
|
14949
15106
|
end
|
14950
15107
|
|
@@ -15736,12 +15893,12 @@ end
|
|
15736
15893
|
# end
|
15737
15894
|
# @since 0.7.0
|
15738
15895
|
#
|
15739
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15896
|
+
# source://yard//lib/yard/tags/directives.rb#257
|
15740
15897
|
class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
15741
15898
|
# @raise [TagFormatError]
|
15742
15899
|
# @since 0.7.0
|
15743
15900
|
#
|
15744
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15901
|
+
# source://yard//lib/yard/tags/directives.rb#258
|
15745
15902
|
def call; end
|
15746
15903
|
|
15747
15904
|
private
|
@@ -15749,40 +15906,40 @@ class YARD::Tags::MacroDirective < ::YARD::Tags::Directive
|
|
15749
15906
|
# @return [Boolean]
|
15750
15907
|
# @since 0.7.0
|
15751
15908
|
#
|
15752
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15909
|
+
# source://yard//lib/yard/tags/directives.rb#287
|
15753
15910
|
def anonymous?; end
|
15754
15911
|
|
15755
15912
|
# @return [Boolean]
|
15756
15913
|
# @since 0.7.0
|
15757
15914
|
#
|
15758
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15915
|
+
# source://yard//lib/yard/tags/directives.rb#276
|
15759
15916
|
def attach?; end
|
15760
15917
|
|
15761
15918
|
# @return [Boolean]
|
15762
15919
|
# @since 0.7.0
|
15763
15920
|
#
|
15764
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15921
|
+
# source://yard//lib/yard/tags/directives.rb#282
|
15765
15922
|
def class_method?; end
|
15766
15923
|
|
15767
15924
|
# @since 0.7.0
|
15768
15925
|
#
|
15769
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15926
|
+
# source://yard//lib/yard/tags/directives.rb#291
|
15770
15927
|
def expand(macro_data); end
|
15771
15928
|
|
15772
15929
|
# @since 0.7.0
|
15773
15930
|
#
|
15774
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15931
|
+
# source://yard//lib/yard/tags/directives.rb#307
|
15775
15932
|
def find_or_create; end
|
15776
15933
|
|
15777
15934
|
# @return [Boolean]
|
15778
15935
|
# @since 0.7.0
|
15779
15936
|
#
|
15780
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15937
|
+
# source://yard//lib/yard/tags/directives.rb#271
|
15781
15938
|
def new?; end
|
15782
15939
|
|
15783
15940
|
# @since 0.7.0
|
15784
15941
|
#
|
15785
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15942
|
+
# source://yard//lib/yard/tags/directives.rb#331
|
15786
15943
|
def warn; end
|
15787
15944
|
end
|
15788
15945
|
|
@@ -15815,49 +15972,49 @@ end
|
|
15815
15972
|
# @see tag:!attribute
|
15816
15973
|
# @since 0.7.0
|
15817
15974
|
#
|
15818
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15975
|
+
# source://yard//lib/yard/tags/directives.rb#367
|
15819
15976
|
class YARD::Tags::MethodDirective < ::YARD::Tags::Directive
|
15820
15977
|
# @since 0.7.0
|
15821
15978
|
#
|
15822
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15979
|
+
# source://yard//lib/yard/tags/directives.rb#372
|
15823
15980
|
def after_parse; end
|
15824
15981
|
|
15825
15982
|
# @since 0.7.0
|
15826
15983
|
#
|
15827
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15984
|
+
# source://yard//lib/yard/tags/directives.rb#370
|
15828
15985
|
def call; end
|
15829
15986
|
|
15830
15987
|
protected
|
15831
15988
|
|
15832
15989
|
# @since 0.7.0
|
15833
15990
|
#
|
15834
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15991
|
+
# source://yard//lib/yard/tags/directives.rb#412
|
15835
15992
|
def create_object; end
|
15836
15993
|
|
15837
15994
|
# @since 0.7.0
|
15838
15995
|
#
|
15839
|
-
# source://yard//lib/yard/tags/directives.rb#
|
15996
|
+
# source://yard//lib/yard/tags/directives.rb#380
|
15840
15997
|
def method_name; end
|
15841
15998
|
|
15842
15999
|
# @since 0.7.0
|
15843
16000
|
#
|
15844
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16001
|
+
# source://yard//lib/yard/tags/directives.rb#389
|
15845
16002
|
def method_signature; end
|
15846
16003
|
|
15847
16004
|
# @since 0.7.0
|
15848
16005
|
#
|
15849
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16006
|
+
# source://yard//lib/yard/tags/directives.rb#393
|
15850
16007
|
def sanitized_tag_signature; end
|
15851
16008
|
|
15852
16009
|
# @since 0.7.0
|
15853
16010
|
#
|
15854
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16011
|
+
# source://yard//lib/yard/tags/directives.rb#402
|
15855
16012
|
def use_indented_text; end
|
15856
16013
|
end
|
15857
16014
|
|
15858
16015
|
# @since 0.7.0
|
15859
16016
|
#
|
15860
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16017
|
+
# source://yard//lib/yard/tags/directives.rb#368
|
15861
16018
|
YARD::Tags::MethodDirective::SCOPE_MATCH = T.let(T.unsafe(nil), Regexp)
|
15862
16019
|
|
15863
16020
|
# source://yard//lib/yard/tags/option_tag.rb#4
|
@@ -15969,11 +16126,11 @@ end
|
|
15969
16126
|
# # }
|
15970
16127
|
# @since 0.8.0
|
15971
16128
|
#
|
15972
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16129
|
+
# source://yard//lib/yard/tags/directives.rb#544
|
15973
16130
|
class YARD::Tags::ParseDirective < ::YARD::Tags::Directive
|
15974
16131
|
# @since 0.8.0
|
15975
16132
|
#
|
15976
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16133
|
+
# source://yard//lib/yard/tags/directives.rb#545
|
15977
16134
|
def call; end
|
15978
16135
|
end
|
15979
16136
|
|
@@ -16057,11 +16214,11 @@ end
|
|
16057
16214
|
# def method2; end
|
16058
16215
|
# @since 0.7.0
|
16059
16216
|
#
|
16060
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16217
|
+
# source://yard//lib/yard/tags/directives.rb#578
|
16061
16218
|
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
|
16062
16219
|
# @since 0.7.0
|
16063
16220
|
#
|
16064
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16221
|
+
# source://yard//lib/yard/tags/directives.rb#579
|
16065
16222
|
def call; end
|
16066
16223
|
end
|
16067
16224
|
|
@@ -16092,7 +16249,7 @@ class YARD::Tags::Tag
|
|
16092
16249
|
# @param name [String] optional key name which the tag refers to
|
16093
16250
|
# @return [Tag] a new instance of Tag
|
16094
16251
|
#
|
16095
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16252
|
+
# source://yard//lib/yard/tags/tag.rb#45
|
16096
16253
|
def initialize(tag_name, text, types = T.unsafe(nil), name = T.unsafe(nil)); end
|
16097
16254
|
|
16098
16255
|
# Provides a plain English summary of the type specification, or nil
|
@@ -16101,27 +16258,29 @@ class YARD::Tags::Tag
|
|
16101
16258
|
# @return [String] a plain English description of the associated types
|
16102
16259
|
# @return [nil] if no types are provided or not parsable
|
16103
16260
|
#
|
16104
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16261
|
+
# source://yard//lib/yard/tags/tag.rb#66
|
16105
16262
|
def explain_types; end
|
16106
16263
|
|
16107
16264
|
# @return [String] a name associated with the tag
|
16265
|
+
# @return [nil] if no tag name is supplied
|
16108
16266
|
#
|
16109
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16267
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16110
16268
|
def name; end
|
16111
16269
|
|
16112
16270
|
# @return [String] a name associated with the tag
|
16271
|
+
# @return [nil] if no tag name is supplied
|
16113
16272
|
#
|
16114
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16273
|
+
# source://yard//lib/yard/tags/tag.rb#27
|
16115
16274
|
def name=(_arg0); end
|
16116
16275
|
|
16117
16276
|
# @return [CodeObjects::Base] the associated object
|
16118
16277
|
#
|
16119
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16278
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16120
16279
|
def object; end
|
16121
16280
|
|
16122
16281
|
# @return [CodeObjects::Base] the associated object
|
16123
16282
|
#
|
16124
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16283
|
+
# source://yard//lib/yard/tags/tag.rb#30
|
16125
16284
|
def object=(_arg0); end
|
16126
16285
|
|
16127
16286
|
# @return [String] the name of the tag
|
@@ -16152,7 +16311,7 @@ class YARD::Tags::Tag
|
|
16152
16311
|
# @return [String] the first of the list of specified types
|
16153
16312
|
# @see #types
|
16154
16313
|
#
|
16155
|
-
# source://yard//lib/yard/tags/tag.rb#
|
16314
|
+
# source://yard//lib/yard/tags/tag.rb#57
|
16156
16315
|
def type; end
|
16157
16316
|
|
16158
16317
|
# @return [Array<String>] a list of types associated with the tag
|
@@ -16343,11 +16502,11 @@ end
|
|
16343
16502
|
# def method2; end
|
16344
16503
|
# @since 0.7.0
|
16345
16504
|
#
|
16346
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16505
|
+
# source://yard//lib/yard/tags/directives.rb#610
|
16347
16506
|
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
|
16348
16507
|
# @since 0.7.0
|
16349
16508
|
#
|
16350
|
-
# source://yard//lib/yard/tags/directives.rb#
|
16509
|
+
# source://yard//lib/yard/tags/directives.rb#611
|
16351
16510
|
def call; end
|
16352
16511
|
end
|
16353
16512
|
|
@@ -16363,7 +16522,7 @@ module YARD::Templates; end
|
|
16363
16522
|
# * To render a template, call {render}.
|
16364
16523
|
# * To register a template path in the lookup paths, call {register_template_path}.
|
16365
16524
|
#
|
16366
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16525
|
+
# source://yard//lib/yard/templates/engine.rb#11
|
16367
16526
|
module YARD::Templates::Engine
|
16368
16527
|
class << self
|
16369
16528
|
# Passes a set of objects to the +:fulldoc+ template for full documentation generation.
|
@@ -16375,7 +16534,7 @@ module YARD::Templates::Engine
|
|
16375
16534
|
# @param options [Hash] (see {render})
|
16376
16535
|
# @return [void]
|
16377
16536
|
#
|
16378
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16537
|
+
# source://yard//lib/yard/templates/engine.rb#100
|
16379
16538
|
def generate(objects, options = T.unsafe(nil)); end
|
16380
16539
|
|
16381
16540
|
# Registers a new template path in {template_paths}
|
@@ -16383,7 +16542,7 @@ module YARD::Templates::Engine
|
|
16383
16542
|
# @param path [String] a new template path
|
16384
16543
|
# @return [void]
|
16385
16544
|
#
|
16386
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16545
|
+
# source://yard//lib/yard/templates/engine.rb#20
|
16387
16546
|
def register_template_path(path); end
|
16388
16547
|
|
16389
16548
|
# Renders a template on a {CodeObjects::Base code object} using
|
@@ -16404,7 +16563,7 @@ module YARD::Templates::Engine
|
|
16404
16563
|
# @param options [Hash] the options hash
|
16405
16564
|
# @return [String] the rendered template
|
16406
16565
|
#
|
16407
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16566
|
+
# source://yard//lib/yard/templates/engine.rb#81
|
16408
16567
|
def render(options = T.unsafe(nil)); end
|
16409
16568
|
|
16410
16569
|
# Creates a template module representing the path. Searches on disk
|
@@ -16418,7 +16577,7 @@ module YARD::Templates::Engine
|
|
16418
16577
|
# {template_paths} on disk.
|
16419
16578
|
# @return [Template] the module representing the template
|
16420
16579
|
#
|
16421
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16580
|
+
# source://yard//lib/yard/templates/engine.rb#34
|
16422
16581
|
def template(*path); end
|
16423
16582
|
|
16424
16583
|
# Forces creation of a template at +path+ within a +full_path+.
|
@@ -16427,17 +16586,17 @@ module YARD::Templates::Engine
|
|
16427
16586
|
# @param full_paths [Array<String>] the full path on disk of the template
|
16428
16587
|
# @return [Template] the template module representing the +path+
|
16429
16588
|
#
|
16430
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16589
|
+
# source://yard//lib/yard/templates/engine.rb#52
|
16431
16590
|
def template!(path, full_paths = T.unsafe(nil)); end
|
16432
16591
|
|
16433
16592
|
# @return [Array<String>] the list of registered template paths
|
16434
16593
|
#
|
16435
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16594
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16436
16595
|
def template_paths; end
|
16437
16596
|
|
16438
16597
|
# @return [Array<String>] the list of registered template paths
|
16439
16598
|
#
|
16440
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16599
|
+
# source://yard//lib/yard/templates/engine.rb#14
|
16441
16600
|
def template_paths=(_arg0); end
|
16442
16601
|
|
16443
16602
|
# Serializes the results of a block with a +serializer+ object.
|
@@ -16448,7 +16607,7 @@ module YARD::Templates::Engine
|
|
16448
16607
|
# @yield a block whose result will be serialize
|
16449
16608
|
# @yieldreturn [String] the contents to serialize
|
16450
16609
|
#
|
16451
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16610
|
+
# source://yard//lib/yard/templates/engine.rb#114
|
16452
16611
|
def with_serializer(object, serializer); end
|
16453
16612
|
|
16454
16613
|
private
|
@@ -16463,7 +16622,7 @@ module YARD::Templates::Engine
|
|
16463
16622
|
# @return [Array<String>] a list of full paths that are existing
|
16464
16623
|
# candidates for a template module
|
16465
16624
|
#
|
16466
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16625
|
+
# source://yard//lib/yard/templates/engine.rb#160
|
16467
16626
|
def find_template_paths(from_template, path); end
|
16468
16627
|
|
16469
16628
|
# Sets default options on the options hash
|
@@ -16474,7 +16633,7 @@ module YARD::Templates::Engine
|
|
16474
16633
|
# @param options [Hash] the options hash
|
16475
16634
|
# @return [void]
|
16476
16635
|
#
|
16477
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16636
|
+
# source://yard//lib/yard/templates/engine.rb#140
|
16478
16637
|
def set_default_options(options = T.unsafe(nil)); end
|
16479
16638
|
|
16480
16639
|
# The name of the module that represents a +path+
|
@@ -16482,7 +16641,7 @@ module YARD::Templates::Engine
|
|
16482
16641
|
# @param path [String] the path to generate a module name for
|
16483
16642
|
# @return [String] the module name
|
16484
16643
|
#
|
16485
|
-
# source://yard//lib/yard/templates/engine.rb#
|
16644
|
+
# source://yard//lib/yard/templates/engine.rb#175
|
16486
16645
|
def template_module_name(path); end
|
16487
16646
|
end
|
16488
16647
|
end
|
@@ -17893,7 +18052,7 @@ end
|
|
17893
18052
|
#
|
17894
18053
|
# @see CLI::YardocOptions
|
17895
18054
|
#
|
17896
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18055
|
+
# source://yard//lib/yard/templates/template_options.rb#10
|
17897
18056
|
class YARD::Templates::TemplateOptions < ::YARD::Options
|
17898
18057
|
# @return [OpenStruct] an open struct containing any global state across all
|
17899
18058
|
# generated objects in a template.
|
@@ -17936,7 +18095,7 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17936
18095
|
# @return [Boolean] whether a mixin matches the embed_mixins list
|
17937
18096
|
# @return [nil] if the mixin is not a module object
|
17938
18097
|
#
|
17939
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18098
|
+
# source://yard//lib/yard/templates/template_options.rb#77
|
17940
18099
|
def embed_mixins_match?(mixin); end
|
17941
18100
|
|
17942
18101
|
# @return [Symbol] the template output format
|
@@ -17983,12 +18142,12 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
17983
18142
|
|
17984
18143
|
# @return [Boolean] whether the page is the "index"
|
17985
18144
|
#
|
17986
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18145
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17987
18146
|
def index; end
|
17988
18147
|
|
17989
18148
|
# @return [Boolean] whether the page is the "index"
|
17990
18149
|
#
|
17991
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18150
|
+
# source://yard//lib/yard/templates/template_options.rb#63
|
17992
18151
|
def index=(_arg0); end
|
17993
18152
|
|
17994
18153
|
# @return [Symbol] the markup format to use when parsing docstrings
|
@@ -18003,51 +18162,51 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18003
18162
|
|
18004
18163
|
# @return [Class] the markup provider class for the markup format
|
18005
18164
|
#
|
18006
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18165
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
18007
18166
|
def markup_provider; end
|
18008
18167
|
|
18009
18168
|
# @return [Class] the markup provider class for the markup format
|
18010
18169
|
#
|
18011
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18170
|
+
# source://yard//lib/yard/templates/template_options.rb#29
|
18012
18171
|
def markup_provider=(_arg0); end
|
18013
18172
|
|
18014
18173
|
# @deprecated use {#highlight} instead.
|
18015
18174
|
# @return [Boolean] whether highlighting should be ignored
|
18016
18175
|
#
|
18017
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18176
|
+
# source://yard//lib/yard/templates/template_options.rb#56
|
18018
18177
|
def no_highlight; end
|
18019
18178
|
|
18020
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18179
|
+
# source://yard//lib/yard/templates/template_options.rb#57
|
18021
18180
|
def no_highlight=(value); end
|
18022
18181
|
|
18023
18182
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18024
18183
|
#
|
18025
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18184
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18026
18185
|
def object; end
|
18027
18186
|
|
18028
18187
|
# @return [CodeObjects::Base] the main object being generated in the template
|
18029
18188
|
#
|
18030
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18189
|
+
# source://yard//lib/yard/templates/template_options.rb#37
|
18031
18190
|
def object=(_arg0); end
|
18032
18191
|
|
18033
18192
|
# @return [CodeObjects::Base] the owner of the generated object
|
18034
18193
|
#
|
18035
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18194
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18036
18195
|
def owner; end
|
18037
18196
|
|
18038
18197
|
# @return [CodeObjects::Base] the owner of the generated object
|
18039
18198
|
#
|
18040
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18199
|
+
# source://yard//lib/yard/templates/template_options.rb#40
|
18041
18200
|
def owner=(_arg0); end
|
18042
18201
|
|
18043
18202
|
# @return [String] the title of a given page
|
18044
18203
|
#
|
18045
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18204
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18046
18205
|
def page_title; end
|
18047
18206
|
|
18048
18207
|
# @return [String] the title of a given page
|
18049
18208
|
#
|
18050
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18209
|
+
# source://yard//lib/yard/templates/template_options.rb#60
|
18051
18210
|
def page_title=(_arg0); end
|
18052
18211
|
|
18053
18212
|
# @return [Boolean] whether serialization should be performed
|
@@ -18063,13 +18222,13 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18063
18222
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18064
18223
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18065
18224
|
#
|
18066
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18225
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18067
18226
|
def serializer; end
|
18068
18227
|
|
18069
18228
|
# @return [Serializers::Base] the serializer used to generate links and serialize
|
18070
18229
|
# output. Serialization output only occurs if {#serialize} is +true+.
|
18071
18230
|
#
|
18072
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18231
|
+
# source://yard//lib/yard/templates/template_options.rb#50
|
18073
18232
|
def serializer=(_arg0); end
|
18074
18233
|
|
18075
18234
|
# @return [Symbol] the template name used to render output
|
@@ -18084,22 +18243,22 @@ class YARD::Templates::TemplateOptions < ::YARD::Options
|
|
18084
18243
|
|
18085
18244
|
# @return [Symbol] the template type used to generate output
|
18086
18245
|
#
|
18087
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18246
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18088
18247
|
def type; end
|
18089
18248
|
|
18090
18249
|
# @return [Symbol] the template type used to generate output
|
18091
18250
|
#
|
18092
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18251
|
+
# source://yard//lib/yard/templates/template_options.rb#43
|
18093
18252
|
def type=(_arg0); end
|
18094
18253
|
|
18095
18254
|
# @return [Verifier] the verifier object
|
18096
18255
|
#
|
18097
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18256
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18098
18257
|
def verifier; end
|
18099
18258
|
|
18100
18259
|
# @return [Verifier] the verifier object
|
18101
18260
|
#
|
18102
|
-
# source://yard//lib/yard/templates/template_options.rb#
|
18261
|
+
# source://yard//lib/yard/templates/template_options.rb#88
|
18103
18262
|
def verifier=(_arg0); end
|
18104
18263
|
end
|
18105
18264
|
|