type_toolkit 0.0.4 → 0.0.6
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/README.md +45 -1
- data/benchmark/.rubocop.yml +7 -0
- data/benchmark/abstract_methods_benchmark.rb +221 -0
- data/benchmark/interface_startup_performance.rb +128 -0
- data/benchmark/module_benchmark.rb +62 -0
- data/config/default.yml +5 -0
- data/docs/design/inherited_implementation_problem.md +119 -0
- data/docs/design/self_dot_methods.md +79 -0
- data/lib/rubocop/cop/type_toolkit/plugin.rb +2 -1
- data/lib/rubocop/cop/type_toolkit/prefer_not_nil.rb +96 -0
- data/lib/rubocop-type_toolkit.rb +1 -0
- data/lib/type_toolkit/abstract_method_receiver.rb +39 -0
- data/lib/type_toolkit/dsl.rb +64 -0
- data/lib/type_toolkit/ext/method.rb +11 -0
- data/lib/type_toolkit/ext/module.rb +7 -0
- data/lib/type_toolkit/ext/nil_assertions.rb +3 -1
- data/lib/type_toolkit/has_abstract_methods.rb +108 -0
- data/lib/type_toolkit/interface.rb +38 -0
- data/lib/type_toolkit/method_def_recorder.rb +53 -0
- data/lib/type_toolkit/method_patch.rb +16 -0
- data/lib/type_toolkit/version.rb +1 -1
- data/lib/type_toolkit.rb +3 -0
- data/sorbet/config +3 -1
- data/sorbet/rbi/gems/benchmark-ips@2.14.0.rbi +981 -0
- data/sorbet/rbi/gems/{erb@6.0.1.rbi → erb@6.0.1.1.rbi} +2 -2
- data/sorbet/rbi/gems/{json@2.18.1.rbi → json@2.19.9.rbi} +115 -161
- data/sorbet/rbi/gems/minitest@5.27.0.rbi +707 -0
- data/sorbet/rbi/gems/rexml@3.4.4.rbi +0 -167
- data/sorbet/rbi/gems/rubocop-ast@1.49.0.rbi +6 -0
- data/sorbet/rbi/gems/rubocop@1.84.2.rbi +7 -0
- data/sorbet/rbi/gems/tapioca@0.17.10.rbi +1 -0
- data/sorbet/rbi/gems/{yard@0.9.38.rbi → yard@0.9.44.rbi} +1206 -241
- data/sorbet/rbi/shims/core.rbi +19 -0
- data/sorbet/rbi/shims/minitest.rbi +5 -2
- data/spec/interface_spec.rb +405 -0
- data/spec/rubocop/cop/type_toolkit/prefer_not_nil_spec.rb +229 -0
- data/spec/spec_helper.rb +14 -0
- metadata +23 -4
|
@@ -283,50 +283,50 @@ class Gem::SourceIndex
|
|
|
283
283
|
end
|
|
284
284
|
end
|
|
285
285
|
|
|
286
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
286
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#35
|
|
287
287
|
class IRB::SLex
|
|
288
288
|
# @return [SLex] a new instance of SLex
|
|
289
289
|
#
|
|
290
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
290
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#43
|
|
291
291
|
def initialize; end
|
|
292
292
|
|
|
293
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
293
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#78
|
|
294
294
|
def create(token, preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
|
|
295
295
|
|
|
296
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
296
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#47
|
|
297
297
|
def def_rule(token, preproc = T.unsafe(nil), postproc = T.unsafe(nil), &block); end
|
|
298
298
|
|
|
299
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
299
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#54
|
|
300
300
|
def def_rules(*tokens, &block); end
|
|
301
301
|
|
|
302
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
302
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#95
|
|
303
303
|
def inspect; end
|
|
304
304
|
|
|
305
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
305
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#82
|
|
306
306
|
def match(token); end
|
|
307
307
|
|
|
308
308
|
# need a check?
|
|
309
309
|
#
|
|
310
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
310
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#69
|
|
311
311
|
def postproc(token); end
|
|
312
312
|
|
|
313
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
313
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#63
|
|
314
314
|
def preproc(token, proc); end
|
|
315
315
|
|
|
316
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
316
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#74
|
|
317
317
|
def search(token); end
|
|
318
318
|
end
|
|
319
319
|
|
|
320
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
320
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#36
|
|
321
321
|
IRB::SLex::DOUT = T.let(T.unsafe(nil), IRB::Notifier::CompositeNotifier)
|
|
322
322
|
|
|
323
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
323
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#38
|
|
324
324
|
IRB::SLex::D_DEBUG = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
|
|
325
325
|
|
|
326
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
326
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#39
|
|
327
327
|
IRB::SLex::D_DETAIL = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
|
|
328
328
|
|
|
329
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
329
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#37
|
|
330
330
|
IRB::SLex::D_WARN = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
|
|
331
331
|
|
|
332
332
|
# ----------------------------------------------------------------------
|
|
@@ -335,17 +335,17 @@ IRB::SLex::D_WARN = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
|
|
|
335
335
|
#
|
|
336
336
|
# ----------------------------------------------------------------------
|
|
337
337
|
#
|
|
338
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
338
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#104
|
|
339
339
|
class IRB::SLex::Node
|
|
340
340
|
# if postproc is nil, this node is an abstract node.
|
|
341
341
|
# if postproc is non-nil, this node is a real node.
|
|
342
342
|
#
|
|
343
343
|
# @return [Node] a new instance of Node
|
|
344
344
|
#
|
|
345
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
345
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#107
|
|
346
346
|
def initialize(preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
|
|
347
347
|
|
|
348
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
348
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#131
|
|
349
349
|
def create_subnode(chrs, preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
|
|
350
350
|
|
|
351
351
|
# chrs: String
|
|
@@ -353,37 +353,37 @@ class IRB::SLex::Node
|
|
|
353
353
|
# io must have getc()/ungetc(); and ungetc() must be
|
|
354
354
|
# able to be called arbitrary number of times.
|
|
355
355
|
#
|
|
356
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
356
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#179
|
|
357
357
|
def match(chrs, op = T.unsafe(nil)); end
|
|
358
358
|
|
|
359
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
359
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#216
|
|
360
360
|
def match_io(io, op = T.unsafe(nil)); end
|
|
361
361
|
|
|
362
362
|
# Returns the value of attribute postproc.
|
|
363
363
|
#
|
|
364
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
364
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#114
|
|
365
365
|
def postproc; end
|
|
366
366
|
|
|
367
367
|
# Sets the attribute postproc
|
|
368
368
|
#
|
|
369
369
|
# @param value the value to set the attribute postproc to.
|
|
370
370
|
#
|
|
371
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
371
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#114
|
|
372
372
|
def postproc=(_arg0); end
|
|
373
373
|
|
|
374
374
|
# Returns the value of attribute preproc.
|
|
375
375
|
#
|
|
376
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
376
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#113
|
|
377
377
|
def preproc; end
|
|
378
378
|
|
|
379
379
|
# Sets the attribute preproc
|
|
380
380
|
#
|
|
381
381
|
# @param value the value to set the attribute preproc to.
|
|
382
382
|
#
|
|
383
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
383
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#113
|
|
384
384
|
def preproc=(_arg0); end
|
|
385
385
|
|
|
386
|
-
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#
|
|
386
|
+
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#116
|
|
387
387
|
def search(chrs, opt = T.unsafe(nil)); end
|
|
388
388
|
end
|
|
389
389
|
|
|
@@ -599,12 +599,7 @@ end
|
|
|
599
599
|
# source://yard//lib/yard.rb#2
|
|
600
600
|
module YARD
|
|
601
601
|
class << self
|
|
602
|
-
# Loads gems that match the name 'yard-*' (recommended) or 'yard_*' except
|
|
603
|
-
# those listed in +~/.yard/ignored_plugins+. This is called immediately
|
|
604
|
-
# after YARD is loaded to allow plugin support.
|
|
605
|
-
#
|
|
606
602
|
# @deprecated Use {Config.load_plugins}
|
|
607
|
-
# @return [Boolean] true if all plugins loaded successfully, false otherwise.
|
|
608
603
|
#
|
|
609
604
|
# source://yard//lib/yard.rb#31
|
|
610
605
|
def load_plugins; end
|
|
@@ -944,84 +939,84 @@ end
|
|
|
944
939
|
#
|
|
945
940
|
# @since 0.6.0
|
|
946
941
|
#
|
|
947
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
942
|
+
# source://yard//lib/yard/cli/diff.rb#12
|
|
948
943
|
class YARD::CLI::Diff < ::YARD::CLI::Command
|
|
949
944
|
# @return [Diff] a new instance of Diff
|
|
950
945
|
# @since 0.6.0
|
|
951
946
|
#
|
|
952
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
947
|
+
# source://yard//lib/yard/cli/diff.rb#13
|
|
953
948
|
def initialize; end
|
|
954
949
|
|
|
955
950
|
# @since 0.6.0
|
|
956
951
|
#
|
|
957
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
952
|
+
# source://yard//lib/yard/cli/diff.rb#25
|
|
958
953
|
def description; end
|
|
959
954
|
|
|
960
955
|
# @since 0.6.0
|
|
961
956
|
#
|
|
962
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
957
|
+
# source://yard//lib/yard/cli/diff.rb#29
|
|
963
958
|
def run(*args); end
|
|
964
959
|
|
|
965
960
|
private
|
|
966
961
|
|
|
967
962
|
# @since 0.6.0
|
|
968
963
|
#
|
|
969
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
964
|
+
# source://yard//lib/yard/cli/diff.rb#84
|
|
970
965
|
def added_objects(registry1, registry2); end
|
|
971
966
|
|
|
972
967
|
# @since 0.6.0
|
|
973
968
|
#
|
|
974
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
969
|
+
# source://yard//lib/yard/cli/diff.rb#79
|
|
975
970
|
def all_objects; end
|
|
976
971
|
|
|
977
972
|
# @since 0.6.0
|
|
978
973
|
#
|
|
979
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
974
|
+
# source://yard//lib/yard/cli/diff.rb#238
|
|
980
975
|
def cleanup(gemfile); end
|
|
981
976
|
|
|
982
977
|
# @since 0.6.0
|
|
983
978
|
#
|
|
984
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
979
|
+
# source://yard//lib/yard/cli/diff.rb#180
|
|
985
980
|
def expand_and_parse(gemfile, io); end
|
|
986
981
|
|
|
987
982
|
# @since 0.6.0
|
|
988
983
|
#
|
|
989
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
984
|
+
# source://yard//lib/yard/cli/diff.rb#192
|
|
990
985
|
def expand_gem(gemfile, io); end
|
|
991
986
|
|
|
992
987
|
# @since 0.6.0
|
|
993
988
|
#
|
|
994
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
989
|
+
# source://yard//lib/yard/cli/diff.rb#186
|
|
995
990
|
def generate_yardoc(dir); end
|
|
996
991
|
|
|
997
992
|
# @since 0.6.0
|
|
998
993
|
#
|
|
999
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
994
|
+
# source://yard//lib/yard/cli/diff.rb#123
|
|
1000
995
|
def load_gem_data(gemfile); end
|
|
1001
996
|
|
|
1002
997
|
# @since 0.6.0
|
|
1003
998
|
#
|
|
1004
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
999
|
+
# source://yard//lib/yard/cli/diff.rb#103
|
|
1005
1000
|
def load_git_commit(commit); end
|
|
1006
1001
|
|
|
1007
1002
|
# @since 0.6.0
|
|
1008
1003
|
#
|
|
1009
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
1004
|
+
# source://yard//lib/yard/cli/diff.rb#88
|
|
1010
1005
|
def modified_objects(registry1, registry2); end
|
|
1011
1006
|
|
|
1012
1007
|
# @since 0.6.0
|
|
1013
1008
|
#
|
|
1014
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
1009
|
+
# source://yard//lib/yard/cli/diff.rb#244
|
|
1015
1010
|
def optparse(*args); end
|
|
1016
1011
|
|
|
1017
1012
|
# @since 0.6.0
|
|
1018
1013
|
#
|
|
1019
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
1014
|
+
# source://yard//lib/yard/cli/diff.rb#99
|
|
1020
1015
|
def removed_objects(registry1, registry2); end
|
|
1021
1016
|
|
|
1022
1017
|
# @since 0.6.0
|
|
1023
1018
|
#
|
|
1024
|
-
# source://yard//lib/yard/cli/diff.rb#
|
|
1019
|
+
# source://yard//lib/yard/cli/diff.rb#230
|
|
1025
1020
|
def require_rubygems; end
|
|
1026
1021
|
end
|
|
1027
1022
|
|
|
@@ -4116,7 +4111,7 @@ class YARD::CodeObjects::Proxy
|
|
|
4116
4111
|
# source://yard//lib/yard/code_objects/proxy.rb#228
|
|
4117
4112
|
def proxy_path; end
|
|
4118
4113
|
|
|
4119
|
-
# @note this method fixes a bug in 1.9.2:
|
|
4114
|
+
# @note this method fixes a bug in 1.9.2: https://gist.github.com/437136
|
|
4120
4115
|
#
|
|
4121
4116
|
# source://yard//lib/yard/code_objects/proxy.rb#205
|
|
4122
4117
|
def to_ary; end
|
|
@@ -5583,7 +5578,7 @@ end
|
|
|
5583
5578
|
#
|
|
5584
5579
|
# @since 0.8.0
|
|
5585
5580
|
#
|
|
5586
|
-
# source://yard//lib/yard/autoload.rb#
|
|
5581
|
+
# source://yard//lib/yard/autoload.rb#84
|
|
5587
5582
|
module YARD::Handlers::C; end
|
|
5588
5583
|
|
|
5589
5584
|
# @since 0.8.0
|
|
@@ -5961,7 +5956,7 @@ class YARD::Handlers::Processor
|
|
|
5961
5956
|
# @param parser [Parser::SourceParser] the parser used to initialize the processor
|
|
5962
5957
|
# @return [Processor] a new instance of Processor
|
|
5963
5958
|
#
|
|
5964
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
5959
|
+
# source://yard//lib/yard/handlers/processor.rb#92
|
|
5965
5960
|
def initialize(parser); end
|
|
5966
5961
|
|
|
5967
5962
|
# Share state across different handlers inside of a file.
|
|
@@ -5974,7 +5969,7 @@ class YARD::Handlers::Processor
|
|
|
5974
5969
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
|
5975
5970
|
# @see #globals
|
|
5976
5971
|
#
|
|
5977
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
5972
|
+
# source://yard//lib/yard/handlers/processor.rb#88
|
|
5978
5973
|
def extra_state; end
|
|
5979
5974
|
|
|
5980
5975
|
# Share state across different handlers inside of a file.
|
|
@@ -5987,17 +5982,17 @@ class YARD::Handlers::Processor
|
|
|
5987
5982
|
# @return [OpenStruct] an open structure that can store arbitrary data
|
|
5988
5983
|
# @see #globals
|
|
5989
5984
|
#
|
|
5990
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
5985
|
+
# source://yard//lib/yard/handlers/processor.rb#88
|
|
5991
5986
|
def extra_state=(_arg0); end
|
|
5992
5987
|
|
|
5993
5988
|
# @return [String] the filename
|
|
5994
5989
|
#
|
|
5995
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
5990
|
+
# source://yard//lib/yard/handlers/processor.rb#41
|
|
5996
5991
|
def file; end
|
|
5997
5992
|
|
|
5998
5993
|
# @return [String] the filename
|
|
5999
5994
|
#
|
|
6000
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
5995
|
+
# source://yard//lib/yard/handlers/processor.rb#41
|
|
6001
5996
|
def file=(_arg0); end
|
|
6002
5997
|
|
|
6003
5998
|
# Searches for all handlers in {Base.subclasses} that match the +statement+
|
|
@@ -6005,7 +6000,7 @@ class YARD::Handlers::Processor
|
|
|
6005
6000
|
# @param statement the statement object to match.
|
|
6006
6001
|
# @return [Array<Base>] a list of handlers to process the statement with.
|
|
6007
6002
|
#
|
|
6008
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6003
|
+
# source://yard//lib/yard/handlers/processor.rb#151
|
|
6009
6004
|
def find_handlers(statement); end
|
|
6010
6005
|
|
|
6011
6006
|
# Handlers can share state for the entire post processing stage through
|
|
@@ -6025,7 +6020,7 @@ class YARD::Handlers::Processor
|
|
|
6025
6020
|
# @return [OpenStruct] global shared state for post-processing stage
|
|
6026
6021
|
# @see #extra_state
|
|
6027
6022
|
#
|
|
6028
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6023
|
+
# source://yard//lib/yard/handlers/processor.rb#77
|
|
6029
6024
|
def globals; end
|
|
6030
6025
|
|
|
6031
6026
|
# Handlers can share state for the entire post processing stage through
|
|
@@ -6045,17 +6040,17 @@ class YARD::Handlers::Processor
|
|
|
6045
6040
|
# @return [OpenStruct] global shared state for post-processing stage
|
|
6046
6041
|
# @see #extra_state
|
|
6047
6042
|
#
|
|
6048
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6043
|
+
# source://yard//lib/yard/handlers/processor.rb#77
|
|
6049
6044
|
def globals=(_arg0); end
|
|
6050
6045
|
|
|
6051
6046
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
|
6052
6047
|
#
|
|
6053
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6048
|
+
# source://yard//lib/yard/handlers/processor.rb#44
|
|
6054
6049
|
def namespace; end
|
|
6055
6050
|
|
|
6056
6051
|
# @return [CodeObjects::NamespaceObject] the current namespace
|
|
6057
6052
|
#
|
|
6058
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6053
|
+
# source://yard//lib/yard/handlers/processor.rb#44
|
|
6059
6054
|
def namespace=(_arg0); end
|
|
6060
6055
|
|
|
6061
6056
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
|
@@ -6063,7 +6058,7 @@ class YARD::Handlers::Processor
|
|
|
6063
6058
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
|
6064
6059
|
# is set as the owner, in case any extra method information is processed.
|
|
6065
6060
|
#
|
|
6066
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6061
|
+
# source://yard//lib/yard/handlers/processor.rb#56
|
|
6067
6062
|
def owner; end
|
|
6068
6063
|
|
|
6069
6064
|
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
|
|
@@ -6071,7 +6066,7 @@ class YARD::Handlers::Processor
|
|
|
6071
6066
|
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
|
|
6072
6067
|
# is set as the owner, in case any extra method information is processed.
|
|
6073
6068
|
#
|
|
6074
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6069
|
+
# source://yard//lib/yard/handlers/processor.rb#56
|
|
6075
6070
|
def owner=(_arg0); end
|
|
6076
6071
|
|
|
6077
6072
|
# Continue parsing the remainder of the files in the +globals.ordered_parser+
|
|
@@ -6081,17 +6076,17 @@ class YARD::Handlers::Processor
|
|
|
6081
6076
|
# @return [void]
|
|
6082
6077
|
# @see Parser::OrderedParser
|
|
6083
6078
|
#
|
|
6084
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6079
|
+
# source://yard//lib/yard/handlers/processor.rb#140
|
|
6085
6080
|
def parse_remaining_files; end
|
|
6086
6081
|
|
|
6087
6082
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
|
6088
6083
|
#
|
|
6089
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6084
|
+
# source://yard//lib/yard/handlers/processor.rb#59
|
|
6090
6085
|
def parser_type; end
|
|
6091
6086
|
|
|
6092
6087
|
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
|
|
6093
6088
|
#
|
|
6094
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6089
|
+
# source://yard//lib/yard/handlers/processor.rb#59
|
|
6095
6090
|
def parser_type=(_arg0); end
|
|
6096
6091
|
|
|
6097
6092
|
# Processes a list of statements by finding handlers to process each
|
|
@@ -6100,27 +6095,27 @@ class YARD::Handlers::Processor
|
|
|
6100
6095
|
# @param statements [Array] a list of statements
|
|
6101
6096
|
# @return [void]
|
|
6102
6097
|
#
|
|
6103
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6098
|
+
# source://yard//lib/yard/handlers/processor.rb#110
|
|
6104
6099
|
def process(statements); end
|
|
6105
6100
|
|
|
6106
6101
|
# @return [Symbol] the current scope (class, instance)
|
|
6107
6102
|
#
|
|
6108
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6103
|
+
# source://yard//lib/yard/handlers/processor.rb#50
|
|
6109
6104
|
def scope; end
|
|
6110
6105
|
|
|
6111
6106
|
# @return [Symbol] the current scope (class, instance)
|
|
6112
6107
|
#
|
|
6113
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6108
|
+
# source://yard//lib/yard/handlers/processor.rb#50
|
|
6114
6109
|
def scope=(_arg0); end
|
|
6115
6110
|
|
|
6116
6111
|
# @return [Symbol] the current visibility (public, private, protected)
|
|
6117
6112
|
#
|
|
6118
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6113
|
+
# source://yard//lib/yard/handlers/processor.rb#47
|
|
6119
6114
|
def visibility; end
|
|
6120
6115
|
|
|
6121
6116
|
# @return [Symbol] the current visibility (public, private, protected)
|
|
6122
6117
|
#
|
|
6123
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6118
|
+
# source://yard//lib/yard/handlers/processor.rb#47
|
|
6124
6119
|
def visibility=(_arg0); end
|
|
6125
6120
|
|
|
6126
6121
|
private
|
|
@@ -6129,7 +6124,7 @@ class YARD::Handlers::Processor
|
|
|
6129
6124
|
#
|
|
6130
6125
|
# @return [Base] the base class
|
|
6131
6126
|
#
|
|
6132
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6127
|
+
# source://yard//lib/yard/handlers/processor.rb#172
|
|
6133
6128
|
def handler_base_class; end
|
|
6134
6129
|
|
|
6135
6130
|
# The module holding the handlers to be loaded
|
|
@@ -6137,12 +6132,12 @@ class YARD::Handlers::Processor
|
|
|
6137
6132
|
# @return [Module] the module containing the handlers depending on
|
|
6138
6133
|
# {#parser_type}.
|
|
6139
6134
|
#
|
|
6140
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6135
|
+
# source://yard//lib/yard/handlers/processor.rb#180
|
|
6141
6136
|
def handler_base_namespace; end
|
|
6142
6137
|
|
|
6143
6138
|
# @return [Boolean]
|
|
6144
6139
|
#
|
|
6145
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6140
|
+
# source://yard//lib/yard/handlers/processor.rb#161
|
|
6146
6141
|
def handles?(handler, statement); end
|
|
6147
6142
|
|
|
6148
6143
|
# Loads handlers from {#handler_base_namespace}. This ensures that
|
|
@@ -6151,7 +6146,7 @@ class YARD::Handlers::Processor
|
|
|
6151
6146
|
#
|
|
6152
6147
|
# @return [void]
|
|
6153
6148
|
#
|
|
6154
|
-
# source://yard//lib/yard/handlers/processor.rb#
|
|
6149
|
+
# source://yard//lib/yard/handlers/processor.rb#188
|
|
6155
6150
|
def load_handlers; end
|
|
6156
6151
|
|
|
6157
6152
|
class << self
|
|
@@ -6171,9 +6166,171 @@ class YARD::Handlers::Processor
|
|
|
6171
6166
|
end
|
|
6172
6167
|
end
|
|
6173
6168
|
|
|
6169
|
+
# Handlers for RBS (Ruby type signature) files.
|
|
6170
|
+
#
|
|
6171
|
+
# source://yard//lib/yard/autoload.rb#73
|
|
6172
|
+
module YARD::Handlers::RBS; end
|
|
6173
|
+
|
|
6174
|
+
# Handles RBS attr_reader, attr_writer, and attr_accessor declarations.
|
|
6175
|
+
#
|
|
6176
|
+
# Registers one or two {YARD::CodeObjects::MethodObject} instances (reader
|
|
6177
|
+
# and/or writer) with @return / @param tags derived from the RBS type.
|
|
6178
|
+
#
|
|
6179
|
+
# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#6
|
|
6180
|
+
class YARD::Handlers::RBS::AttributeHandler < ::YARD::Handlers::RBS::Base
|
|
6181
|
+
private
|
|
6182
|
+
|
|
6183
|
+
# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#66
|
|
6184
|
+
def apply_tag_types(obj, tag_name, types, tag_param_name = T.unsafe(nil)); end
|
|
6185
|
+
|
|
6186
|
+
# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#55
|
|
6187
|
+
def register_existing_attribute_method(attr_name, meth_name, type, scope); end
|
|
6188
|
+
|
|
6189
|
+
# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#30
|
|
6190
|
+
def register_reader(name, types, scope); end
|
|
6191
|
+
|
|
6192
|
+
# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#42
|
|
6193
|
+
def register_writer(name, types, scope); end
|
|
6194
|
+
end
|
|
6195
|
+
|
|
6196
|
+
# Base class for all RBS handlers.
|
|
6197
|
+
# Handlers match on the {Parser::RBS::Statement#type} symbol of the
|
|
6198
|
+
# current statement and process it to create or annotate code objects.
|
|
6199
|
+
#
|
|
6200
|
+
# source://yard//lib/yard/handlers/rbs/base.rb#9
|
|
6201
|
+
class YARD::Handlers::RBS::Base < ::YARD::Handlers::Base
|
|
6202
|
+
# Recurse into the body of a namespace statement.
|
|
6203
|
+
#
|
|
6204
|
+
# @param opts [Hash] state overrides
|
|
6205
|
+
# @see #push_state
|
|
6206
|
+
#
|
|
6207
|
+
# source://yard//lib/yard/handlers/rbs/base.rb#29
|
|
6208
|
+
def parse_block(opts = T.unsafe(nil)); end
|
|
6209
|
+
|
|
6210
|
+
class << self
|
|
6211
|
+
# @return [Boolean] whether this handler matches the given statement
|
|
6212
|
+
#
|
|
6213
|
+
# source://yard//lib/yard/handlers/rbs/base.rb#11
|
|
6214
|
+
def handles?(statement, _processor); end
|
|
6215
|
+
end
|
|
6216
|
+
end
|
|
6217
|
+
|
|
6218
|
+
# Handles RBS constant declarations: `Name: Type`
|
|
6219
|
+
#
|
|
6220
|
+
# source://yard//lib/yard/handlers/rbs/constant_handler.rb#3
|
|
6221
|
+
class YARD::Handlers::RBS::ConstantHandler < ::YARD::Handlers::RBS::Base
|
|
6222
|
+
private
|
|
6223
|
+
|
|
6224
|
+
# source://yard//lib/yard/handlers/rbs/constant_handler.rb#15
|
|
6225
|
+
def rbs_types(type_str); end
|
|
6226
|
+
end
|
|
6227
|
+
|
|
6228
|
+
# Handles RBS method definitions (def name: signature).
|
|
6229
|
+
#
|
|
6230
|
+
# Creates a {YARD::CodeObjects::MethodObject} for each declaration
|
|
6231
|
+
# and infers @param, @return, @yield, and @yieldparam tags from the
|
|
6232
|
+
# RBS type signature when those tags are absent from the docstring.
|
|
6233
|
+
#
|
|
6234
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#7
|
|
6235
|
+
class YARD::Handlers::RBS::MethodHandler < ::YARD::Handlers::RBS::Base
|
|
6236
|
+
private
|
|
6237
|
+
|
|
6238
|
+
# Add an @overload tag for one signature overload.
|
|
6239
|
+
#
|
|
6240
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#86
|
|
6241
|
+
def add_overload_tag(obj, meth_name, sig); end
|
|
6242
|
+
|
|
6243
|
+
# Add @param / @return / @yield / @yieldparam from a single overload sig.
|
|
6244
|
+
#
|
|
6245
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#66
|
|
6246
|
+
def add_param_return_tags(obj, sig); end
|
|
6247
|
+
|
|
6248
|
+
# Add @yield and @yieldparam tags from a parsed block type.
|
|
6249
|
+
#
|
|
6250
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#108
|
|
6251
|
+
def add_yield_tags(obj, blk); end
|
|
6252
|
+
|
|
6253
|
+
# Apply tags from all overload signatures to the method object.
|
|
6254
|
+
#
|
|
6255
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#53
|
|
6256
|
+
def apply_signature_tags(obj, sigs); end
|
|
6257
|
+
|
|
6258
|
+
# Split a type+name string like "Array[String] names" into ["Array[String]", "names"].
|
|
6259
|
+
# The name is the trailing lowercase identifier (if any).
|
|
6260
|
+
#
|
|
6261
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#213
|
|
6262
|
+
def extract_type_and_name(str); end
|
|
6263
|
+
|
|
6264
|
+
# Find the index of the matching close bracket starting from +start+.
|
|
6265
|
+
#
|
|
6266
|
+
# @return [nil] if no matching bracket is found (malformed input).
|
|
6267
|
+
#
|
|
6268
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#247
|
|
6269
|
+
def find_matching(str, start, open, close); end
|
|
6270
|
+
|
|
6271
|
+
# Parse the inside of a `{ ... }` block type, e.g. "(Integer) -> String".
|
|
6272
|
+
#
|
|
6273
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#227
|
|
6274
|
+
def parse_block_type(inner); end
|
|
6275
|
+
|
|
6276
|
+
# Parse a single RBS function type string (one overload) into its components.
|
|
6277
|
+
#
|
|
6278
|
+
# @param sig [String] e.g. "(String name, Integer age) -> String"
|
|
6279
|
+
# @return [Hash] { :params => [...], :block_param => Hash|nil, :return_types => [...] }
|
|
6280
|
+
#
|
|
6281
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#125
|
|
6282
|
+
def parse_function_type(sig); end
|
|
6283
|
+
|
|
6284
|
+
# Parse a comma-separated parameter list (content inside outer parens).
|
|
6285
|
+
#
|
|
6286
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#162
|
|
6287
|
+
def parse_params_list(str); end
|
|
6288
|
+
|
|
6289
|
+
# Parse one parameter from an RBS param list.
|
|
6290
|
+
#
|
|
6291
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#170
|
|
6292
|
+
def parse_single_param(param); end
|
|
6293
|
+
|
|
6294
|
+
# Split +str+ on commas that are not inside brackets.
|
|
6295
|
+
#
|
|
6296
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#261
|
|
6297
|
+
def split_by_comma(str); end
|
|
6298
|
+
|
|
6299
|
+
class << self
|
|
6300
|
+
# Return the bracket depth of the full string (should be 0 for well-formed types).
|
|
6301
|
+
#
|
|
6302
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#317
|
|
6303
|
+
def bracket_depth(str); end
|
|
6304
|
+
|
|
6305
|
+
# Convert an RBS type string to an array of YARD type strings.
|
|
6306
|
+
#
|
|
6307
|
+
# @param rbs [String] e.g. "String | Integer", "Array[String]", "bool"
|
|
6308
|
+
# @return [Array<String>]
|
|
6309
|
+
#
|
|
6310
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#30
|
|
6311
|
+
def rbs_type_to_yard_types(rbs); end
|
|
6312
|
+
|
|
6313
|
+
# Split +str+ on `|` that are not inside brackets.
|
|
6314
|
+
#
|
|
6315
|
+
# source://yard//lib/yard/handlers/rbs/method_handler.rb#289
|
|
6316
|
+
def split_on_pipe(str); end
|
|
6317
|
+
end
|
|
6318
|
+
end
|
|
6319
|
+
|
|
6320
|
+
# Handles RBS include, extend, and prepend declarations.
|
|
6321
|
+
#
|
|
6322
|
+
# source://yard//lib/yard/handlers/rbs/mixin_handler.rb#3
|
|
6323
|
+
class YARD::Handlers::RBS::MixinHandler < ::YARD::Handlers::RBS::Base; end
|
|
6324
|
+
|
|
6325
|
+
# Handles RBS class, module, and interface declarations by registering
|
|
6326
|
+
# the corresponding namespace code objects and recursing into their bodies.
|
|
6327
|
+
#
|
|
6328
|
+
# source://yard//lib/yard/handlers/rbs/namespace_handler.rb#4
|
|
6329
|
+
class YARD::Handlers::RBS::NamespaceHandler < ::YARD::Handlers::RBS::Base; end
|
|
6330
|
+
|
|
6174
6331
|
# All Ruby handlers
|
|
6175
6332
|
#
|
|
6176
|
-
# source://yard//lib/yard/autoload.rb#
|
|
6333
|
+
# source://yard//lib/yard/autoload.rb#102
|
|
6177
6334
|
module YARD::Handlers::Ruby; end
|
|
6178
6335
|
|
|
6179
6336
|
# Handles alias and alias_method calls
|
|
@@ -6194,7 +6351,7 @@ class YARD::Handlers::Ruby::AttributeHandler < ::YARD::Handlers::Ruby::Base
|
|
|
6194
6351
|
# @raise [Parser::UndocumentableError] if the arguments are not valid.
|
|
6195
6352
|
# @return [Array<String>] the validated attribute names
|
|
6196
6353
|
#
|
|
6197
|
-
# source://yard//lib/yard/handlers/ruby/attribute_handler.rb#
|
|
6354
|
+
# source://yard//lib/yard/handlers/ruby/attribute_handler.rb#78
|
|
6198
6355
|
def validated_attribute_names(params); end
|
|
6199
6356
|
end
|
|
6200
6357
|
|
|
@@ -6352,7 +6509,7 @@ class YARD::Handlers::Ruby::ConstantHandler < ::YARD::Handlers::Ruby::Base
|
|
|
6352
6509
|
# @param superclass [MethodCallNode] the AST node for the Struct.new or Data.define call
|
|
6353
6510
|
# @return [Array<String>] the member names to generate methods for
|
|
6354
6511
|
#
|
|
6355
|
-
# source://yard//lib/yard/handlers/ruby/constant_handler.rb#
|
|
6512
|
+
# source://yard//lib/yard/handlers/ruby/constant_handler.rb#67
|
|
6356
6513
|
def extract_parameters(superclass); end
|
|
6357
6514
|
|
|
6358
6515
|
# source://yard//lib/yard/handlers/ruby/constant_handler.rb#24
|
|
@@ -6490,7 +6647,7 @@ end
|
|
|
6490
6647
|
|
|
6491
6648
|
# Handlers for old Ruby 1.8 parser
|
|
6492
6649
|
#
|
|
6493
|
-
# source://yard//lib/yard/autoload.rb#
|
|
6650
|
+
# source://yard//lib/yard/autoload.rb#103
|
|
6494
6651
|
module YARD::Handlers::Ruby::Legacy; end
|
|
6495
6652
|
|
|
6496
6653
|
# Handles alias and alias_method calls
|
|
@@ -7018,7 +7175,7 @@ class YARD::Handlers::Ruby::YieldHandler < ::YARD::Handlers::Ruby::Base; end
|
|
|
7018
7175
|
#
|
|
7019
7176
|
# @since 0.8.0
|
|
7020
7177
|
#
|
|
7021
|
-
# source://yard//lib/yard/autoload.rb#
|
|
7178
|
+
# source://yard//lib/yard/autoload.rb#161
|
|
7022
7179
|
module YARD::I18n; end
|
|
7023
7180
|
|
|
7024
7181
|
# +Locale+ is a unit of translation. It has {#name} and a set of
|
|
@@ -7049,7 +7206,7 @@ class YARD::I18n::Locale
|
|
|
7049
7206
|
|
|
7050
7207
|
# @return [String] the name of the locale. It used IETF language
|
|
7051
7208
|
# tag format +[language[_territory][.codeset][@modifier]]+.
|
|
7052
|
-
# @see
|
|
7209
|
+
# @see https://tools.ietf.org/rfc/bcp/bcp47.txt BCP 47 - Tags for Identifying Languages
|
|
7053
7210
|
# @since 0.8.2
|
|
7054
7211
|
#
|
|
7055
7212
|
# source://yard//lib/yard/i18n/locale.rb#29
|
|
@@ -7261,7 +7418,7 @@ end
|
|
|
7261
7418
|
# File.open(po_file_path, "w") do |pot_file|
|
|
7262
7419
|
# pot_file.print(pot)
|
|
7263
7420
|
# end
|
|
7264
|
-
# @see
|
|
7421
|
+
# @see https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html GNU gettext manual about details of PO file
|
|
7265
7422
|
# @since 0.8.0
|
|
7266
7423
|
#
|
|
7267
7424
|
# source://yard//lib/yard/i18n/pot_generator.rb#65
|
|
@@ -7997,7 +8154,7 @@ end
|
|
|
7997
8154
|
# The parser namespace holds all parsing engines used by YARD.
|
|
7998
8155
|
# Currently only Ruby and C (Ruby) parsers are implemented.
|
|
7999
8156
|
#
|
|
8000
|
-
# source://yard//lib/yard/autoload.rb#
|
|
8157
|
+
# source://yard//lib/yard/autoload.rb#171
|
|
8001
8158
|
module YARD::Parser; end
|
|
8002
8159
|
|
|
8003
8160
|
# Represents the abstract base parser class that parses source code in
|
|
@@ -8072,7 +8229,7 @@ end
|
|
|
8072
8229
|
|
|
8073
8230
|
# CRuby Parsing components
|
|
8074
8231
|
#
|
|
8075
|
-
# source://yard//lib/yard/autoload.rb#
|
|
8232
|
+
# source://yard//lib/yard/autoload.rb#172
|
|
8076
8233
|
module YARD::Parser::C; end
|
|
8077
8234
|
|
|
8078
8235
|
# source://yard//lib/yard/parser/c/statement.rb#41
|
|
@@ -8403,9 +8560,170 @@ end
|
|
|
8403
8560
|
# source://yard//lib/yard/parser/source_parser.rb#12
|
|
8404
8561
|
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
|
|
8405
8562
|
|
|
8563
|
+
# RBS type signature parser
|
|
8564
|
+
#
|
|
8565
|
+
# source://yard//lib/yard/autoload.rb#197
|
|
8566
|
+
module YARD::Parser::RBS; end
|
|
8567
|
+
|
|
8568
|
+
# Parses RBS (Ruby type signature) files and produces a list of
|
|
8569
|
+
# {Statement} objects for post-processing by handlers.
|
|
8570
|
+
#
|
|
8571
|
+
# RBS is Ruby's official type signature format (introduced in Ruby 3.0).
|
|
8572
|
+
# This parser handles: class/module/interface declarations, method
|
|
8573
|
+
# signatures, attribute accessors, mixins, and constants.
|
|
8574
|
+
#
|
|
8575
|
+
# No external gem dependencies are used; the parser is hand-written.
|
|
8576
|
+
#
|
|
8577
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#13
|
|
8578
|
+
class YARD::Parser::RBS::RbsParser < ::YARD::Parser::Base
|
|
8579
|
+
# @param filename [String] path to the source file
|
|
8580
|
+
# @param source [String] source code to parse
|
|
8581
|
+
# @return [RbsParser] a new instance of RbsParser
|
|
8582
|
+
#
|
|
8583
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#16
|
|
8584
|
+
def initialize(source, filename); end
|
|
8585
|
+
|
|
8586
|
+
# @return [Array<Statement>] top-level statements for the post-processor
|
|
8587
|
+
#
|
|
8588
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#36
|
|
8589
|
+
def enumerator; end
|
|
8590
|
+
|
|
8591
|
+
# Parses the source and returns self.
|
|
8592
|
+
#
|
|
8593
|
+
# @return [RbsParser] self
|
|
8594
|
+
#
|
|
8595
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#24
|
|
8596
|
+
def parse; end
|
|
8597
|
+
|
|
8598
|
+
# Tokenization is not implemented for RBS.
|
|
8599
|
+
#
|
|
8600
|
+
# @raise [NotImplementedError]
|
|
8601
|
+
#
|
|
8602
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#31
|
|
8603
|
+
def tokenize; end
|
|
8604
|
+
|
|
8605
|
+
private
|
|
8606
|
+
|
|
8607
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#296
|
|
8608
|
+
def parse_attr(type, lines, i, docs, crange); end
|
|
8609
|
+
|
|
8610
|
+
# Parse a sequence of lines, returning statements and the index after the last consumed line.
|
|
8611
|
+
#
|
|
8612
|
+
# @param lines [Array<String>] source lines
|
|
8613
|
+
# @param start [Integer] index to start from (0-based)
|
|
8614
|
+
# @param stop_at_end [Boolean] when true, stop parsing when we see a bare `end`
|
|
8615
|
+
# @return [Array(Array<Statement>, Integer)] [statements, new_index]
|
|
8616
|
+
#
|
|
8617
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#48
|
|
8618
|
+
def parse_body(lines, start, stop_at_end); end
|
|
8619
|
+
|
|
8620
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#253
|
|
8621
|
+
def parse_method_def(sanitized, lines, i, docs, crange); end
|
|
8622
|
+
|
|
8623
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#199
|
|
8624
|
+
def parse_namespace(type, lines, i, docs, crange); end
|
|
8625
|
+
|
|
8626
|
+
# Dispatch a single declaration line.
|
|
8627
|
+
#
|
|
8628
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#125
|
|
8629
|
+
def parse_statement(lines, i, comments, comment_start_1); end
|
|
8630
|
+
|
|
8631
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#112
|
|
8632
|
+
def sanitized_statement_lines(lines, start_index); end
|
|
8633
|
+
|
|
8634
|
+
# source://yard//lib/yard/parser/rbs/rbs_parser.rb#86
|
|
8635
|
+
def strip_inline_comment(line); end
|
|
8636
|
+
end
|
|
8637
|
+
|
|
8638
|
+
# Represents a single parsed declaration from an RBS file.
|
|
8639
|
+
# Each Statement may have a block of child statements for
|
|
8640
|
+
# namespace declarations (class, module, interface).
|
|
8641
|
+
#
|
|
8642
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#8
|
|
8643
|
+
class YARD::Parser::RBS::Statement
|
|
8644
|
+
# @return [Statement] a new instance of Statement
|
|
8645
|
+
#
|
|
8646
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#52
|
|
8647
|
+
def initialize(attrs = T.unsafe(nil)); end
|
|
8648
|
+
|
|
8649
|
+
# @return [String, nil] RBS type annotation for attrs and constants
|
|
8650
|
+
#
|
|
8651
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#47
|
|
8652
|
+
def attr_rbs_type; end
|
|
8653
|
+
|
|
8654
|
+
# @return [Array<Statement>] child statements for namespace blocks
|
|
8655
|
+
#
|
|
8656
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#37
|
|
8657
|
+
def block; end
|
|
8658
|
+
|
|
8659
|
+
# @return [String, nil] adjacent comment text (the docstring)
|
|
8660
|
+
#
|
|
8661
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#28
|
|
8662
|
+
def comments; end
|
|
8663
|
+
|
|
8664
|
+
# @return [false] RBS files don't use ## hash-flag comments
|
|
8665
|
+
#
|
|
8666
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#34
|
|
8667
|
+
def comments_hash_flag; end
|
|
8668
|
+
|
|
8669
|
+
# @return [Range, nil] line range of the preceding comments
|
|
8670
|
+
#
|
|
8671
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#31
|
|
8672
|
+
def comments_range; end
|
|
8673
|
+
|
|
8674
|
+
# @return [Integer] 1-indexed line number of this statement
|
|
8675
|
+
#
|
|
8676
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#22
|
|
8677
|
+
def line; end
|
|
8678
|
+
|
|
8679
|
+
# @return [String, nil] mixin name for :include/:extend/:prepend
|
|
8680
|
+
#
|
|
8681
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#44
|
|
8682
|
+
def mixin_name; end
|
|
8683
|
+
|
|
8684
|
+
# @return [String] the declaration name
|
|
8685
|
+
#
|
|
8686
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#16
|
|
8687
|
+
def name; end
|
|
8688
|
+
|
|
8689
|
+
# @return [String] a textual snippet used in error messages
|
|
8690
|
+
#
|
|
8691
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#69
|
|
8692
|
+
def show; end
|
|
8693
|
+
|
|
8694
|
+
# @return [Array<String>] RBS type signature strings for :method_def
|
|
8695
|
+
# Each element is one overload (e.g. "(String name) -> Integer")
|
|
8696
|
+
#
|
|
8697
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#41
|
|
8698
|
+
def signatures; end
|
|
8699
|
+
|
|
8700
|
+
# @return [String] raw source text of the statement
|
|
8701
|
+
#
|
|
8702
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#25
|
|
8703
|
+
def source; end
|
|
8704
|
+
|
|
8705
|
+
# @return [String, nil] the superclass name (for :class)
|
|
8706
|
+
#
|
|
8707
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#19
|
|
8708
|
+
def superclass; end
|
|
8709
|
+
|
|
8710
|
+
# @return [Symbol] declaration type:
|
|
8711
|
+
# :class, :module, :interface, :method_def,
|
|
8712
|
+
# :attr_reader, :attr_writer, :attr_accessor,
|
|
8713
|
+
# :include, :extend, :prepend, :constant, :alias
|
|
8714
|
+
#
|
|
8715
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#13
|
|
8716
|
+
def type; end
|
|
8717
|
+
|
|
8718
|
+
# @return [Symbol, nil] :class or :instance scope hint from parser
|
|
8719
|
+
#
|
|
8720
|
+
# source://yard//lib/yard/parser/rbs/statement.rb#50
|
|
8721
|
+
def visibility; end
|
|
8722
|
+
end
|
|
8723
|
+
|
|
8406
8724
|
# Ruby parsing components.
|
|
8407
8725
|
#
|
|
8408
|
-
# source://yard//lib/yard/autoload.rb#
|
|
8726
|
+
# source://yard//lib/yard/autoload.rb#181
|
|
8409
8727
|
module YARD::Parser::Ruby
|
|
8410
8728
|
# Builds and s-expression by creating {AstNode} objects with
|
|
8411
8729
|
# the type provided by the first argument.
|
|
@@ -8820,7 +9138,7 @@ end
|
|
|
8820
9138
|
|
|
8821
9139
|
# Handles Ruby parsing in Ruby 1.8.
|
|
8822
9140
|
#
|
|
8823
|
-
# source://yard//lib/yard/autoload.rb#
|
|
9141
|
+
# source://yard//lib/yard/autoload.rb#182
|
|
8824
9142
|
module YARD::Parser::Ruby::Legacy; end
|
|
8825
9143
|
|
|
8826
9144
|
# Lexical analyzer for Ruby source
|
|
@@ -10343,9 +10661,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10343
10661
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#154
|
|
10344
10662
|
def on_args_new(*args); end
|
|
10345
10663
|
|
|
10346
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
10347
|
-
def on_aryptn(*args); end
|
|
10348
|
-
|
|
10349
10664
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
10350
10665
|
def on_assign(*args); end
|
|
10351
10666
|
|
|
@@ -10460,9 +10775,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10460
10775
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10461
10776
|
def on_float(tok); end
|
|
10462
10777
|
|
|
10463
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
10464
|
-
def on_fndptn(*args); end
|
|
10465
|
-
|
|
10466
10778
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#168
|
|
10467
10779
|
def on_for(*args); end
|
|
10468
10780
|
|
|
@@ -10478,9 +10790,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10478
10790
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10479
10791
|
def on_heredoc_end(tok); end
|
|
10480
10792
|
|
|
10481
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
10482
|
-
def on_hshptn(*args); end
|
|
10483
|
-
|
|
10484
10793
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10485
10794
|
def on_ident(tok); end
|
|
10486
10795
|
|
|
@@ -10616,9 +10925,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10616
10925
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10617
10926
|
def on_rational(tok); end
|
|
10618
10927
|
|
|
10619
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10620
|
-
def on_rbrace(tok); end
|
|
10621
|
-
|
|
10622
10928
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#168
|
|
10623
10929
|
def on_redo(*args); end
|
|
10624
10930
|
|
|
@@ -10814,34 +11120,34 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10814
11120
|
|
|
10815
11121
|
# @since 0.5.6
|
|
10816
11122
|
#
|
|
10817
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11123
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#747
|
|
10818
11124
|
def add_comment(line, node = T.unsafe(nil), before_node = T.unsafe(nil), into = T.unsafe(nil)); end
|
|
10819
11125
|
|
|
10820
11126
|
# @since 0.5.6
|
|
10821
11127
|
#
|
|
10822
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11128
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#286
|
|
10823
11129
|
def add_token(token, data); end
|
|
10824
11130
|
|
|
10825
11131
|
# @return [Boolean]
|
|
10826
11132
|
# @since 0.5.6
|
|
10827
11133
|
#
|
|
10828
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11134
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#671
|
|
10829
11135
|
def comment_starts_line?(charno); end
|
|
10830
11136
|
|
|
10831
11137
|
# @raise [ParserSyntaxError]
|
|
10832
11138
|
# @since 0.5.6
|
|
10833
11139
|
#
|
|
10834
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11140
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#669
|
|
10835
11141
|
def compile_error(msg); end
|
|
10836
11142
|
|
|
10837
11143
|
# @since 0.5.6
|
|
10838
11144
|
#
|
|
10839
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11145
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#778
|
|
10840
11146
|
def freeze_tree(node = T.unsafe(nil)); end
|
|
10841
11147
|
|
|
10842
11148
|
# @since 0.5.6
|
|
10843
11149
|
#
|
|
10844
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11150
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#681
|
|
10845
11151
|
def insert_comments; end
|
|
10846
11152
|
|
|
10847
11153
|
# @since 0.5.6
|
|
@@ -10859,6 +11165,17 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10859
11165
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#168
|
|
10860
11166
|
def on_array(other); end
|
|
10861
11167
|
|
|
11168
|
+
# Ruby 3.0+ pattern matching: array patterns (SomeClass[a, b]) and find patterns
|
|
11169
|
+
# (SomeClass[*pre, val, *post]) use [...] brackets, which fire on_lbracket and
|
|
11170
|
+
# on_rbracket scanner events. The corresponding parser events are on_aryptn/on_fndptn
|
|
11171
|
+
# (not on_aref), so we must clean up the bracket maps to prevent stale entries from
|
|
11172
|
+
# corrupting source ranges of later array indexing expressions.
|
|
11173
|
+
#
|
|
11174
|
+
# @since 0.5.6
|
|
11175
|
+
#
|
|
11176
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
11177
|
+
def on_aryptn(*args); end
|
|
11178
|
+
|
|
10862
11179
|
# @since 0.5.6
|
|
10863
11180
|
#
|
|
10864
11181
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
@@ -10876,7 +11193,7 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10876
11193
|
|
|
10877
11194
|
# @since 0.5.6
|
|
10878
11195
|
#
|
|
10879
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11196
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#363
|
|
10880
11197
|
def on_body_stmt(*args); end
|
|
10881
11198
|
|
|
10882
11199
|
# @since 0.5.6
|
|
@@ -10914,11 +11231,28 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10914
11231
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
10915
11232
|
def on_embdoc_end(text); end
|
|
10916
11233
|
|
|
11234
|
+
# @since 0.5.6
|
|
11235
|
+
#
|
|
11236
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
11237
|
+
def on_fndptn(*args); end
|
|
11238
|
+
|
|
10917
11239
|
# @since 0.5.6
|
|
10918
11240
|
#
|
|
10919
11241
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#168
|
|
10920
11242
|
def on_hash(*args); end
|
|
10921
11243
|
|
|
11244
|
+
# Ruby 3.0+ pattern matching: braced hash patterns ({key: val} syntax) fire
|
|
11245
|
+
# on_lbrace and on_rbrace scanner events. The corresponding parser event is
|
|
11246
|
+
# on_hshptn (not on_hash), so we must clean up the brace maps to prevent stale
|
|
11247
|
+
# entries from corrupting source ranges of later hash literals and brace blocks.
|
|
11248
|
+
# Bare hash patterns (key: val without braces) fire no brace scanner events, so
|
|
11249
|
+
# we only clean up when @map[:rbrace] confirms a closing brace was scanned.
|
|
11250
|
+
#
|
|
11251
|
+
# @since 0.5.6
|
|
11252
|
+
#
|
|
11253
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
11254
|
+
def on_hshptn(*args); end
|
|
11255
|
+
|
|
10922
11256
|
# @since 0.5.6
|
|
10923
11257
|
#
|
|
10924
11258
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
@@ -10950,6 +11284,14 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10950
11284
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#175
|
|
10951
11285
|
def on_program(*args); end
|
|
10952
11286
|
|
|
11287
|
+
# Maintained explicitly (unlike on_lbracket/on_rbracket) so on_hshptn can
|
|
11288
|
+
# distinguish braced from bare hash patterns in Ruby 3.0+ pattern matching.
|
|
11289
|
+
#
|
|
11290
|
+
# @since 0.5.6
|
|
11291
|
+
#
|
|
11292
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
11293
|
+
def on_rbrace(tok); end
|
|
11294
|
+
|
|
10953
11295
|
# @since 0.5.6
|
|
10954
11296
|
#
|
|
10955
11297
|
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#186
|
|
@@ -10997,12 +11339,12 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
|
|
|
10997
11339
|
|
|
10998
11340
|
# @since 0.5.6
|
|
10999
11341
|
#
|
|
11000
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11342
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#263
|
|
11001
11343
|
def visit_event_arr(node); end
|
|
11002
11344
|
|
|
11003
11345
|
# @since 0.5.6
|
|
11004
11346
|
#
|
|
11005
|
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#
|
|
11347
|
+
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#271
|
|
11006
11348
|
def visit_ns_token(token, data, ast_token = T.unsafe(nil)); end
|
|
11007
11349
|
end
|
|
11008
11350
|
|
|
@@ -11173,30 +11515,30 @@ class YARD::Parser::SourceParser
|
|
|
11173
11515
|
# @overload initialize
|
|
11174
11516
|
# @return [SourceParser] a new instance of SourceParser
|
|
11175
11517
|
#
|
|
11176
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11518
|
+
# source://yard//lib/yard/parser/source_parser.rb#407
|
|
11177
11519
|
def initialize(parser_type = T.unsafe(nil), globals1 = T.unsafe(nil), globals2 = T.unsafe(nil)); end
|
|
11178
11520
|
|
|
11179
11521
|
# @return [String] the contents of the file to be parsed
|
|
11180
11522
|
# @since 0.7.0
|
|
11181
11523
|
#
|
|
11182
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11524
|
+
# source://yard//lib/yard/parser/source_parser.rb#400
|
|
11183
11525
|
def contents; end
|
|
11184
11526
|
|
|
11185
11527
|
# @return [String] the filename being parsed by the parser.
|
|
11186
11528
|
#
|
|
11187
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11529
|
+
# source://yard//lib/yard/parser/source_parser.rb#387
|
|
11188
11530
|
def file; end
|
|
11189
11531
|
|
|
11190
11532
|
# @return [String] the filename being parsed by the parser.
|
|
11191
11533
|
#
|
|
11192
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11534
|
+
# source://yard//lib/yard/parser/source_parser.rb#387
|
|
11193
11535
|
def file=(_arg0); end
|
|
11194
11536
|
|
|
11195
11537
|
# @return [OpenStruct] an open struct containing arbitrary global state
|
|
11196
11538
|
# shared between files and handlers.
|
|
11197
11539
|
# @since 0.7.0
|
|
11198
11540
|
#
|
|
11199
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11541
|
+
# source://yard//lib/yard/parser/source_parser.rb#396
|
|
11200
11542
|
def globals; end
|
|
11201
11543
|
|
|
11202
11544
|
# The main parser method. This should not be called directly. Instead,
|
|
@@ -11205,13 +11547,13 @@ class YARD::Parser::SourceParser
|
|
|
11205
11547
|
# @param content [String, #read, Object] the source file to parse
|
|
11206
11548
|
# @return [Object, nil] the parser object used to parse the source
|
|
11207
11549
|
#
|
|
11208
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11550
|
+
# source://yard//lib/yard/parser/source_parser.rb#419
|
|
11209
11551
|
def parse(content = T.unsafe(nil)); end
|
|
11210
11552
|
|
|
11211
11553
|
# @return [Symbol] the parser type associated with the parser instance.
|
|
11212
11554
|
# This should be set by the {#initialize constructor}.
|
|
11213
11555
|
#
|
|
11214
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11556
|
+
# source://yard//lib/yard/parser/source_parser.rb#391
|
|
11215
11557
|
def parser_type; end
|
|
11216
11558
|
|
|
11217
11559
|
# Tokenizes but does not parse the block of code using the current {#parser_type}
|
|
@@ -11219,7 +11561,7 @@ class YARD::Parser::SourceParser
|
|
|
11219
11561
|
# @param content [String] the block of code to tokenize
|
|
11220
11562
|
# @return [Array] a list of tokens
|
|
11221
11563
|
#
|
|
11222
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11564
|
+
# source://yard//lib/yard/parser/source_parser.rb#463
|
|
11223
11565
|
def tokenize(content); end
|
|
11224
11566
|
|
|
11225
11567
|
private
|
|
@@ -11228,15 +11570,15 @@ class YARD::Parser::SourceParser
|
|
|
11228
11570
|
#
|
|
11229
11571
|
# @since 0.5.3
|
|
11230
11572
|
#
|
|
11231
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11573
|
+
# source://yard//lib/yard/parser/source_parser.rb#472
|
|
11232
11574
|
def convert_encoding(content); end
|
|
11233
11575
|
|
|
11234
11576
|
# @since 0.5.6
|
|
11235
11577
|
#
|
|
11236
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11578
|
+
# source://yard//lib/yard/parser/source_parser.rb#516
|
|
11237
11579
|
def parser_class; end
|
|
11238
11580
|
|
|
11239
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11581
|
+
# source://yard//lib/yard/parser/source_parser.rb#501
|
|
11240
11582
|
def parser_type=(value); end
|
|
11241
11583
|
|
|
11242
11584
|
# Guesses the parser type to use depending on the file extension.
|
|
@@ -11244,14 +11586,14 @@ class YARD::Parser::SourceParser
|
|
|
11244
11586
|
# @param filename [String] the filename to use to guess the parser type
|
|
11245
11587
|
# @return [Symbol] a parser type that matches the filename
|
|
11246
11588
|
#
|
|
11247
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11589
|
+
# source://yard//lib/yard/parser/source_parser.rb#509
|
|
11248
11590
|
def parser_type_for_filename(filename); end
|
|
11249
11591
|
|
|
11250
11592
|
# Runs a {Handlers::Processor} object to post process the parsed statements.
|
|
11251
11593
|
#
|
|
11252
11594
|
# @return [void]
|
|
11253
11595
|
#
|
|
11254
|
-
# source://yard//lib/yard/parser/source_parser.rb#
|
|
11596
|
+
# source://yard//lib/yard/parser/source_parser.rb#491
|
|
11255
11597
|
def post_process; end
|
|
11256
11598
|
|
|
11257
11599
|
class << self
|
|
@@ -11555,7 +11897,7 @@ YARD::ROOT = T.let(T.unsafe(nil), String)
|
|
|
11555
11897
|
|
|
11556
11898
|
# Holds Rake tasks used by YARD
|
|
11557
11899
|
#
|
|
11558
|
-
# source://yard//lib/yard/autoload.rb#
|
|
11900
|
+
# source://yard//lib/yard/autoload.rb#208
|
|
11559
11901
|
module YARD::Rake; end
|
|
11560
11902
|
|
|
11561
11903
|
# The rake task to run {CLI::Yardoc} and generate documentation.
|
|
@@ -12121,48 +12463,48 @@ class YARD::RegistryResolver
|
|
|
12121
12463
|
#
|
|
12122
12464
|
# @since 0.9.1
|
|
12123
12465
|
#
|
|
12124
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12466
|
+
# source://yard//lib/yard/registry_resolver.rb#188
|
|
12125
12467
|
def collect_namespaces(object); end
|
|
12126
12468
|
|
|
12127
12469
|
# Performs a lexical lookup from a namespace for a path and a type hint.
|
|
12128
12470
|
#
|
|
12129
12471
|
# @since 0.9.1
|
|
12130
12472
|
#
|
|
12131
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12473
|
+
# source://yard//lib/yard/registry_resolver.rb#111
|
|
12132
12474
|
def lookup_path_direct(namespace, path, type); end
|
|
12133
12475
|
|
|
12134
12476
|
# Performs a lookup through the inheritance chain on a path with a type hint.
|
|
12135
12477
|
#
|
|
12136
12478
|
# @since 0.9.1
|
|
12137
12479
|
#
|
|
12138
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12480
|
+
# source://yard//lib/yard/registry_resolver.rb#128
|
|
12139
12481
|
def lookup_path_inherited(namespace, path, type); end
|
|
12140
12482
|
|
|
12141
12483
|
# @return [Regexp] the regexp that can be used to split a string on all
|
|
12142
12484
|
# occurrences of separator tokens
|
|
12143
12485
|
# @since 0.9.1
|
|
12144
12486
|
#
|
|
12145
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12487
|
+
# source://yard//lib/yard/registry_resolver.rb#213
|
|
12146
12488
|
def split_on_separators_match; end
|
|
12147
12489
|
|
|
12148
12490
|
# @return [Regexp] the regexp match of the default separator
|
|
12149
12491
|
# @since 0.9.1
|
|
12150
12492
|
#
|
|
12151
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12493
|
+
# source://yard//lib/yard/registry_resolver.rb#201
|
|
12152
12494
|
def starts_with_default_separator_match; end
|
|
12153
12495
|
|
|
12154
12496
|
# @return [Regexp] the regexp that matches strings starting with
|
|
12155
12497
|
# a separator
|
|
12156
12498
|
# @since 0.9.1
|
|
12157
12499
|
#
|
|
12158
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12500
|
+
# source://yard//lib/yard/registry_resolver.rb#207
|
|
12159
12501
|
def starts_with_separator_match; end
|
|
12160
12502
|
|
|
12161
12503
|
# return [Boolean] if the obj's type matches the provided type.
|
|
12162
12504
|
#
|
|
12163
12505
|
# @since 0.9.1
|
|
12164
12506
|
#
|
|
12165
|
-
# source://yard//lib/yard/registry_resolver.rb#
|
|
12507
|
+
# source://yard//lib/yard/registry_resolver.rb#106
|
|
12166
12508
|
def validate(obj, type); end
|
|
12167
12509
|
end
|
|
12168
12510
|
|
|
@@ -12407,7 +12749,7 @@ end
|
|
|
12407
12749
|
|
|
12408
12750
|
# Namespace for components that serialize to various endpoints
|
|
12409
12751
|
#
|
|
12410
|
-
# source://yard//lib/yard/autoload.rb#
|
|
12752
|
+
# source://yard//lib/yard/autoload.rb#212
|
|
12411
12753
|
module YARD::Serializers; end
|
|
12412
12754
|
|
|
12413
12755
|
# The abstract base serializer. Serializers allow templates to be
|
|
@@ -12708,7 +13050,7 @@ end
|
|
|
12708
13050
|
#
|
|
12709
13051
|
# @since 0.6.0
|
|
12710
13052
|
#
|
|
12711
|
-
# source://yard//lib/yard/autoload.rb#
|
|
13053
|
+
# source://yard//lib/yard/autoload.rb#230
|
|
12712
13054
|
module YARD::Server
|
|
12713
13055
|
class << self
|
|
12714
13056
|
# Registers a static path to be used in static asset lookup.
|
|
@@ -12877,7 +13219,7 @@ YARD::Server::CRLF = T.let(T.unsafe(nil), String)
|
|
|
12877
13219
|
#
|
|
12878
13220
|
# @since 0.6.0
|
|
12879
13221
|
#
|
|
12880
|
-
# source://yard//lib/yard/autoload.rb#
|
|
13222
|
+
# source://yard//lib/yard/autoload.rb#235
|
|
12881
13223
|
module YARD::Server::Commands; end
|
|
12882
13224
|
|
|
12883
13225
|
# This is the base command class used to implement custom commands for
|
|
@@ -12909,8 +13251,10 @@ module YARD::Server::Commands; end
|
|
|
12909
13251
|
# @see #run
|
|
12910
13252
|
# @since 0.6.0
|
|
12911
13253
|
#
|
|
12912
|
-
# source://yard//lib/yard/server/commands/base.rb#
|
|
13254
|
+
# source://yard//lib/yard/server/commands/base.rb#32
|
|
12913
13255
|
class YARD::Server::Commands::Base
|
|
13256
|
+
include ::YARD::Server::StaticCaching
|
|
13257
|
+
|
|
12914
13258
|
# Creates a new command object, setting attributes named by keys
|
|
12915
13259
|
# in the options hash. After initialization, the options hash
|
|
12916
13260
|
# is saved in {#command_options} for further inspection.
|
|
@@ -13078,7 +13422,7 @@ class YARD::Server::Commands::Base
|
|
|
13078
13422
|
# @return [void]
|
|
13079
13423
|
# @since 0.6.0
|
|
13080
13424
|
#
|
|
13081
|
-
# source://yard//lib/yard/server/commands/base.rb#
|
|
13425
|
+
# source://yard//lib/yard/server/commands/base.rb#174
|
|
13082
13426
|
def not_found; end
|
|
13083
13427
|
|
|
13084
13428
|
# Sets the headers and status code for a redirection to a given URL
|
|
@@ -13087,7 +13431,7 @@ class YARD::Server::Commands::Base
|
|
|
13087
13431
|
# @raise [FinishRequest] causes the request to terminate.
|
|
13088
13432
|
# @since 0.6.0
|
|
13089
13433
|
#
|
|
13090
|
-
# source://yard//lib/yard/server/commands/base.rb#
|
|
13434
|
+
# source://yard//lib/yard/server/commands/base.rb#186
|
|
13091
13435
|
def redirect(url); end
|
|
13092
13436
|
|
|
13093
13437
|
# Renders a specific object if provided, or a regular template rendering
|
|
@@ -13110,7 +13454,7 @@ class YARD::Server::Commands::Base
|
|
|
13110
13454
|
#
|
|
13111
13455
|
# @since 0.6.0
|
|
13112
13456
|
#
|
|
13113
|
-
# source://yard//lib/yard/server/commands/base.rb#
|
|
13457
|
+
# source://yard//lib/yard/server/commands/base.rb#196
|
|
13114
13458
|
def add_cache_control; end
|
|
13115
13459
|
end
|
|
13116
13460
|
|
|
@@ -14290,7 +14634,7 @@ class YARD::Server::LibraryNotPreparedError < ::RuntimeError; end
|
|
|
14290
14634
|
# def load_yardoc_from_http
|
|
14291
14635
|
# Thread.new do
|
|
14292
14636
|
# # zip/unzip method implementations are not shown
|
|
14293
|
-
# download_zip_file("
|
|
14637
|
+
# download_zip_file("https://mysite.com/yardocs/#{self}.zip")
|
|
14294
14638
|
# unzip_file_to("/path/to/yardocs/#{self}")
|
|
14295
14639
|
# end
|
|
14296
14640
|
#
|
|
@@ -14721,16 +15065,24 @@ end
|
|
|
14721
15065
|
# @see Router Router documentation for "Caching"
|
|
14722
15066
|
# @since 0.6.0
|
|
14723
15067
|
#
|
|
14724
|
-
# source://yard//lib/yard/server/static_caching.rb#
|
|
15068
|
+
# source://yard//lib/yard/server/static_caching.rb#9
|
|
14725
15069
|
module YARD::Server::StaticCaching
|
|
15070
|
+
# Caches rendered HTML response data to disk.
|
|
15071
|
+
#
|
|
15072
|
+
# @param data [String] the data to cache
|
|
15073
|
+
# @return [void]
|
|
15074
|
+
# @since 0.9.44
|
|
15075
|
+
#
|
|
15076
|
+
# source://yard//lib/yard/server/static_caching.rb#52
|
|
15077
|
+
def cache(data); end
|
|
15078
|
+
|
|
14726
15079
|
# Called by a router to return the cached object. By default, this
|
|
14727
15080
|
# method performs disk-based caching. To perform other forms of caching,
|
|
14728
15081
|
# implement your own +#check_static_cache+ method and mix the module into
|
|
14729
15082
|
# the Router class.
|
|
14730
15083
|
#
|
|
14731
|
-
#
|
|
14732
|
-
#
|
|
14733
|
-
# {Commands::Base#cache}.
|
|
15084
|
+
# This method checks for the existence of cached data. To actually cache
|
|
15085
|
+
# a response, see {#cache}.
|
|
14734
15086
|
#
|
|
14735
15087
|
# @example Implementing In-Memory Cache Checking
|
|
14736
15088
|
# module MemoryCaching
|
|
@@ -14751,8 +15103,15 @@ module YARD::Server::StaticCaching
|
|
|
14751
15103
|
# @see Commands::Base#cache
|
|
14752
15104
|
# @since 0.6.0
|
|
14753
15105
|
#
|
|
14754
|
-
# source://yard//lib/yard/server/static_caching.rb#
|
|
15106
|
+
# source://yard//lib/yard/server/static_caching.rb#35
|
|
14755
15107
|
def check_static_cache; end
|
|
15108
|
+
|
|
15109
|
+
private
|
|
15110
|
+
|
|
15111
|
+
# @since 0.6.0
|
|
15112
|
+
#
|
|
15113
|
+
# source://yard//lib/yard/server/static_caching.rb#65
|
|
15114
|
+
def cache_path(request_path); end
|
|
14756
15115
|
end
|
|
14757
15116
|
|
|
14758
15117
|
# Stubs marshal dumps and acts a delegate class for an object by path
|
|
@@ -14791,7 +15150,7 @@ YARD::TEMPLATE_ROOT = T.let(T.unsafe(nil), String)
|
|
|
14791
15150
|
|
|
14792
15151
|
# Namespace for Tag components
|
|
14793
15152
|
#
|
|
14794
|
-
# source://yard//lib/yard/autoload.rb#
|
|
15153
|
+
# source://yard//lib/yard/autoload.rb#264
|
|
14795
15154
|
module YARD::Tags; end
|
|
14796
15155
|
|
|
14797
15156
|
# Defines an attribute with a given name, using indented block data as the
|
|
@@ -15505,7 +15864,7 @@ class YARD::Tags::Library
|
|
|
15505
15864
|
#
|
|
15506
15865
|
# @example
|
|
15507
15866
|
# # Synchronizes system time using NTP.
|
|
15508
|
-
# # @see
|
|
15867
|
+
# # @see https://ntp.org/documentation.html NTP Documentation
|
|
15509
15868
|
# # @see NTPHelperMethods
|
|
15510
15869
|
# class NTPUpdater; end
|
|
15511
15870
|
#
|
|
@@ -15553,7 +15912,7 @@ class YARD::Tags::Library
|
|
|
15553
15912
|
# @example
|
|
15554
15913
|
# # @todo Add support for Jabberwocky service.
|
|
15555
15914
|
# # There is an open source Jabberwocky library available
|
|
15556
|
-
# # at
|
|
15915
|
+
# # at https://jbrwcky.org that can be easily integrated.
|
|
15557
15916
|
# class Wonderlander; end
|
|
15558
15917
|
# @see tag:note
|
|
15559
15918
|
#
|
|
@@ -15568,7 +15927,7 @@ class YARD::Tags::Library
|
|
|
15568
15927
|
# of a specific object.
|
|
15569
15928
|
#
|
|
15570
15929
|
# @example
|
|
15571
|
-
# # The public REST API for
|
|
15930
|
+
# # The public REST API for https://jbrwcky.org
|
|
15572
15931
|
# # @version 2.0
|
|
15573
15932
|
# class JabberwockyAPI; end
|
|
15574
15933
|
#
|
|
@@ -16229,11 +16588,11 @@ end
|
|
|
16229
16588
|
# def method2; end
|
|
16230
16589
|
# @since 0.7.0
|
|
16231
16590
|
#
|
|
16232
|
-
# source://yard//lib/yard/tags/directives.rb#
|
|
16591
|
+
# source://yard//lib/yard/tags/directives.rb#585
|
|
16233
16592
|
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
|
|
16234
16593
|
# @since 0.7.0
|
|
16235
16594
|
#
|
|
16236
|
-
# source://yard//lib/yard/tags/directives.rb#
|
|
16595
|
+
# source://yard//lib/yard/tags/directives.rb#586
|
|
16237
16596
|
def call; end
|
|
16238
16597
|
end
|
|
16239
16598
|
|
|
@@ -16355,7 +16714,7 @@ class YARD::Tags::TypesExplainer
|
|
|
16355
16714
|
# @return [String] a plain English description of the associated types
|
|
16356
16715
|
# @return [nil] if no types are provided or not parsable
|
|
16357
16716
|
#
|
|
16358
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16717
|
+
# source://yard//lib/yard/tags/types_explainer.rb#12
|
|
16359
16718
|
def explain(*types); end
|
|
16360
16719
|
|
|
16361
16720
|
# Provides a plain English summary of the type specification, or nil
|
|
@@ -16366,136 +16725,174 @@ class YARD::Tags::TypesExplainer
|
|
|
16366
16725
|
# @return [String] a plain English description of the associated types
|
|
16367
16726
|
# @return [nil] if no types are provided or not parsable
|
|
16368
16727
|
#
|
|
16369
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16728
|
+
# source://yard//lib/yard/tags/types_explainer.rb#20
|
|
16370
16729
|
def explain!(*types); end
|
|
16371
16730
|
|
|
16372
16731
|
private
|
|
16373
16732
|
|
|
16374
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16733
|
+
# source://yard//lib/yard/tags/types_explainer.rb#25
|
|
16375
16734
|
def new(*_arg0); end
|
|
16376
16735
|
end
|
|
16377
16736
|
end
|
|
16378
16737
|
|
|
16379
16738
|
# @private
|
|
16380
16739
|
#
|
|
16381
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16740
|
+
# source://yard//lib/yard/tags/types_explainer.rb#73
|
|
16382
16741
|
class YARD::Tags::TypesExplainer::CollectionType < ::YARD::Tags::TypesExplainer::Type
|
|
16383
16742
|
# @return [CollectionType] a new instance of CollectionType
|
|
16384
16743
|
#
|
|
16385
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16744
|
+
# source://yard//lib/yard/tags/types_explainer.rb#76
|
|
16386
16745
|
def initialize(name, types); end
|
|
16387
16746
|
|
|
16388
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16747
|
+
# source://yard//lib/yard/tags/types_explainer.rb#81
|
|
16389
16748
|
def to_s(_singular = T.unsafe(nil)); end
|
|
16390
16749
|
|
|
16391
16750
|
# Returns the value of attribute types.
|
|
16392
16751
|
#
|
|
16393
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16752
|
+
# source://yard//lib/yard/tags/types_explainer.rb#74
|
|
16394
16753
|
def types; end
|
|
16395
16754
|
|
|
16396
16755
|
# Sets the attribute types
|
|
16397
16756
|
#
|
|
16398
16757
|
# @param value the value to set the attribute types to.
|
|
16399
16758
|
#
|
|
16400
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16759
|
+
# source://yard//lib/yard/tags/types_explainer.rb#74
|
|
16401
16760
|
def types=(_arg0); end
|
|
16402
16761
|
end
|
|
16403
16762
|
|
|
16404
16763
|
# @private
|
|
16405
16764
|
#
|
|
16406
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16765
|
+
# source://yard//lib/yard/tags/types_explainer.rb#66
|
|
16766
|
+
class YARD::Tags::TypesExplainer::DuckType < ::YARD::Tags::TypesExplainer::Type
|
|
16767
|
+
# source://yard//lib/yard/tags/types_explainer.rb#67
|
|
16768
|
+
def to_s(singular = T.unsafe(nil)); end
|
|
16769
|
+
end
|
|
16770
|
+
|
|
16771
|
+
# @private
|
|
16772
|
+
#
|
|
16773
|
+
# source://yard//lib/yard/tags/types_explainer.rb#87
|
|
16407
16774
|
class YARD::Tags::TypesExplainer::FixedCollectionType < ::YARD::Tags::TypesExplainer::CollectionType
|
|
16408
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16775
|
+
# source://yard//lib/yard/tags/types_explainer.rb#88
|
|
16409
16776
|
def to_s(_singular = T.unsafe(nil)); end
|
|
16410
16777
|
end
|
|
16411
16778
|
|
|
16412
16779
|
# @private
|
|
16413
16780
|
#
|
|
16414
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16781
|
+
# source://yard//lib/yard/tags/types_explainer.rb#94
|
|
16415
16782
|
class YARD::Tags::TypesExplainer::HashCollectionType < ::YARD::Tags::TypesExplainer::Type
|
|
16416
16783
|
# @return [HashCollectionType] a new instance of HashCollectionType
|
|
16417
16784
|
#
|
|
16418
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16419
|
-
def initialize(name,
|
|
16785
|
+
# source://yard//lib/yard/tags/types_explainer.rb#97
|
|
16786
|
+
def initialize(name, key_types_or_pairs, value_types = T.unsafe(nil)); end
|
|
16420
16787
|
|
|
16421
|
-
#
|
|
16788
|
+
# Backward compatibility accessors
|
|
16422
16789
|
#
|
|
16423
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16790
|
+
# source://yard//lib/yard/tags/types_explainer.rb#110
|
|
16424
16791
|
def key_types; end
|
|
16425
16792
|
|
|
16426
|
-
#
|
|
16793
|
+
# source://yard//lib/yard/tags/types_explainer.rb#115
|
|
16794
|
+
def key_types=(types); end
|
|
16795
|
+
|
|
16796
|
+
# Returns the value of attribute key_value_pairs.
|
|
16797
|
+
#
|
|
16798
|
+
# source://yard//lib/yard/tags/types_explainer.rb#95
|
|
16799
|
+
def key_value_pairs; end
|
|
16800
|
+
|
|
16801
|
+
# Sets the attribute key_value_pairs
|
|
16427
16802
|
#
|
|
16428
|
-
# @param value the value to set the attribute
|
|
16803
|
+
# @param value the value to set the attribute key_value_pairs to.
|
|
16429
16804
|
#
|
|
16430
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16431
|
-
def
|
|
16805
|
+
# source://yard//lib/yard/tags/types_explainer.rb#95
|
|
16806
|
+
def key_value_pairs=(_arg0); end
|
|
16432
16807
|
|
|
16433
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16808
|
+
# source://yard//lib/yard/tags/types_explainer.rb#136
|
|
16434
16809
|
def to_s(_singular = T.unsafe(nil)); end
|
|
16435
16810
|
|
|
16436
|
-
#
|
|
16437
|
-
#
|
|
16438
|
-
# source://yard//lib/yard/tags/types_explainer.rb#80
|
|
16811
|
+
# source://yard//lib/yard/tags/types_explainer.rb#123
|
|
16439
16812
|
def value_types; end
|
|
16440
16813
|
|
|
16441
|
-
#
|
|
16442
|
-
|
|
16443
|
-
|
|
16444
|
-
|
|
16445
|
-
|
|
16446
|
-
|
|
16814
|
+
# source://yard//lib/yard/tags/types_explainer.rb#128
|
|
16815
|
+
def value_types=(types); end
|
|
16816
|
+
end
|
|
16817
|
+
|
|
16818
|
+
# Regular expression to match symbol and string literals
|
|
16819
|
+
#
|
|
16820
|
+
# source://yard//lib/yard/tags/types_explainer.rb#8
|
|
16821
|
+
YARD::Tags::TypesExplainer::LITERALMATCH = T.let(T.unsafe(nil), Regexp)
|
|
16822
|
+
|
|
16823
|
+
# @private
|
|
16824
|
+
#
|
|
16825
|
+
# source://yard//lib/yard/tags/types_explainer.rb#59
|
|
16826
|
+
class YARD::Tags::TypesExplainer::LiteralType < ::YARD::Tags::TypesExplainer::Type
|
|
16827
|
+
# source://yard//lib/yard/tags/types_explainer.rb#60
|
|
16828
|
+
def to_s(_singular = T.unsafe(nil)); end
|
|
16447
16829
|
end
|
|
16448
16830
|
|
|
16449
16831
|
# @private
|
|
16450
16832
|
#
|
|
16451
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16833
|
+
# source://yard//lib/yard/tags/types_explainer.rb#149
|
|
16452
16834
|
class YARD::Tags::TypesExplainer::Parser
|
|
16453
16835
|
include ::YARD::CodeObjects
|
|
16454
16836
|
|
|
16455
16837
|
# @return [Parser] a new instance of Parser
|
|
16456
16838
|
#
|
|
16457
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16839
|
+
# source://yard//lib/yard/tags/types_explainer.rb#173
|
|
16458
16840
|
def initialize(string); end
|
|
16459
16841
|
|
|
16460
|
-
#
|
|
16461
|
-
|
|
16842
|
+
# @return [Array(Boolean, Array<Type>)] - finished, types
|
|
16843
|
+
#
|
|
16844
|
+
# source://yard//lib/yard/tags/types_explainer.rb#178
|
|
16845
|
+
def parse(until_tokens: T.unsafe(nil)); end
|
|
16846
|
+
|
|
16847
|
+
private
|
|
16848
|
+
|
|
16849
|
+
# source://yard//lib/yard/tags/types_explainer.rb#264
|
|
16850
|
+
def create_type(name); end
|
|
16851
|
+
|
|
16852
|
+
# source://yard//lib/yard/tags/types_explainer.rb#233
|
|
16853
|
+
def parse_hash_collection(name); end
|
|
16854
|
+
|
|
16855
|
+
# @return [Array<Type>]
|
|
16856
|
+
#
|
|
16857
|
+
# source://yard//lib/yard/tags/types_explainer.rb#215
|
|
16858
|
+
def parse_with_handlers; end
|
|
16462
16859
|
|
|
16463
16860
|
class << self
|
|
16464
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16861
|
+
# source://yard//lib/yard/tags/types_explainer.rb#169
|
|
16465
16862
|
def parse(string); end
|
|
16466
16863
|
end
|
|
16467
16864
|
end
|
|
16468
16865
|
|
|
16469
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16866
|
+
# source://yard//lib/yard/tags/types_explainer.rb#152
|
|
16470
16867
|
YARD::Tags::TypesExplainer::Parser::TOKENS = T.let(T.unsafe(nil), Hash)
|
|
16471
16868
|
|
|
16472
16869
|
# @private
|
|
16473
16870
|
#
|
|
16474
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16871
|
+
# source://yard//lib/yard/tags/types_explainer.rb#29
|
|
16475
16872
|
class YARD::Tags::TypesExplainer::Type
|
|
16476
16873
|
# @return [Type] a new instance of Type
|
|
16477
16874
|
#
|
|
16478
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16875
|
+
# source://yard//lib/yard/tags/types_explainer.rb#32
|
|
16479
16876
|
def initialize(name); end
|
|
16480
16877
|
|
|
16481
16878
|
# Returns the value of attribute name.
|
|
16482
16879
|
#
|
|
16483
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16880
|
+
# source://yard//lib/yard/tags/types_explainer.rb#30
|
|
16484
16881
|
def name; end
|
|
16485
16882
|
|
|
16486
16883
|
# Sets the attribute name
|
|
16487
16884
|
#
|
|
16488
16885
|
# @param value the value to set the attribute name to.
|
|
16489
16886
|
#
|
|
16490
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16887
|
+
# source://yard//lib/yard/tags/types_explainer.rb#30
|
|
16491
16888
|
def name=(_arg0); end
|
|
16492
16889
|
|
|
16493
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16890
|
+
# source://yard//lib/yard/tags/types_explainer.rb#36
|
|
16494
16891
|
def to_s(singular = T.unsafe(nil)); end
|
|
16495
16892
|
|
|
16496
|
-
|
|
16893
|
+
protected
|
|
16497
16894
|
|
|
16498
|
-
# source://yard//lib/yard/tags/types_explainer.rb#
|
|
16895
|
+
# source://yard//lib/yard/tags/types_explainer.rb#46
|
|
16499
16896
|
def list_join(list, with: T.unsafe(nil)); end
|
|
16500
16897
|
end
|
|
16501
16898
|
|
|
@@ -16518,17 +16915,17 @@ end
|
|
|
16518
16915
|
# def method2; end
|
|
16519
16916
|
# @since 0.7.0
|
|
16520
16917
|
#
|
|
16521
|
-
# source://yard//lib/yard/tags/directives.rb#
|
|
16918
|
+
# source://yard//lib/yard/tags/directives.rb#617
|
|
16522
16919
|
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
|
|
16523
16920
|
# @since 0.7.0
|
|
16524
16921
|
#
|
|
16525
|
-
# source://yard//lib/yard/tags/directives.rb#
|
|
16922
|
+
# source://yard//lib/yard/tags/directives.rb#618
|
|
16526
16923
|
def call; end
|
|
16527
16924
|
end
|
|
16528
16925
|
|
|
16529
16926
|
# Namespace for templating system
|
|
16530
16927
|
#
|
|
16531
|
-
# source://yard//lib/yard/autoload.rb#
|
|
16928
|
+
# source://yard//lib/yard/autoload.rb#287
|
|
16532
16929
|
module YARD::Templates; end
|
|
16533
16930
|
|
|
16534
16931
|
# This module manages all creation, handling and rendering of {Template}
|
|
@@ -16681,7 +17078,7 @@ end
|
|
|
16681
17078
|
|
|
16682
17079
|
# Namespace for template helpers
|
|
16683
17080
|
#
|
|
16684
|
-
# source://yard//lib/yard/autoload.rb#
|
|
17081
|
+
# source://yard//lib/yard/autoload.rb#288
|
|
16685
17082
|
module YARD::Templates::Helpers; end
|
|
16686
17083
|
|
|
16687
17084
|
# The base helper module included in all templates.
|
|
@@ -16801,7 +17198,7 @@ module YARD::Templates::Helpers::BaseHelper
|
|
|
16801
17198
|
# @example Including docstring contents of an object
|
|
16802
17199
|
# linkify('include:YARD::Docstring')
|
|
16803
17200
|
# @example Linking a URL
|
|
16804
|
-
# linkify('
|
|
17201
|
+
# linkify('https://example.com')
|
|
16805
17202
|
# @example Linking an object by path
|
|
16806
17203
|
# linkify('YARD::Docstring')
|
|
16807
17204
|
# @example Linking to an extra file
|
|
@@ -16887,7 +17284,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16887
17284
|
# @param object [CodeObjects::Base] the object to get an anchor for
|
|
16888
17285
|
# @return [String] the anchor for a specific object
|
|
16889
17286
|
#
|
|
16890
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17287
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#357
|
|
16891
17288
|
def anchor_for(object); end
|
|
16892
17289
|
|
|
16893
17290
|
# Returns the current character set. The default value can be overridden
|
|
@@ -16898,14 +17295,14 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16898
17295
|
# @return [String] the current character set
|
|
16899
17296
|
# @since 0.5.4
|
|
16900
17297
|
#
|
|
16901
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17298
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#584
|
|
16902
17299
|
def charset; end
|
|
16903
17300
|
|
|
16904
17301
|
# Formats a list of objects and links them
|
|
16905
17302
|
#
|
|
16906
17303
|
# @return [String] a formatted list of objects
|
|
16907
17304
|
#
|
|
16908
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17305
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#468
|
|
16909
17306
|
def format_object_name_list(objects); end
|
|
16910
17307
|
|
|
16911
17308
|
# Formats a list of types from a tag.
|
|
@@ -16917,7 +17314,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16917
17314
|
# as [Type1, Type2, ...] with the types linked
|
|
16918
17315
|
# to their respective descriptions.
|
|
16919
17316
|
#
|
|
16920
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17317
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#486
|
|
16921
17318
|
def format_types(typelist, brackets = T.unsafe(nil)); end
|
|
16922
17319
|
|
|
16923
17320
|
# Escapes HTML entities
|
|
@@ -16933,7 +17330,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16933
17330
|
# @param text [String] input Asciidoc text
|
|
16934
17331
|
# @return [String] output HTML
|
|
16935
17332
|
#
|
|
16936
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17333
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#119
|
|
16937
17334
|
def html_markup_asciidoc(text); end
|
|
16938
17335
|
|
|
16939
17336
|
# Converts HTML to HTML
|
|
@@ -16942,7 +17339,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16942
17339
|
# @return [String] output HTML
|
|
16943
17340
|
# @since 0.6.0
|
|
16944
17341
|
#
|
|
16945
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17342
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#178
|
|
16946
17343
|
def html_markup_html(text); end
|
|
16947
17344
|
|
|
16948
17345
|
# Converts Markdown to HTML
|
|
@@ -16957,7 +17354,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16957
17354
|
# @return [String] the same text with no markup
|
|
16958
17355
|
# @since 0.6.6
|
|
16959
17356
|
#
|
|
16960
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17357
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#170
|
|
16961
17358
|
def html_markup_none(text); end
|
|
16962
17359
|
|
|
16963
17360
|
# Converts org-mode to HTML
|
|
@@ -16965,7 +17362,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16965
17362
|
# @param text [String] input org-mode text
|
|
16966
17363
|
# @return [String] output HTML
|
|
16967
17364
|
#
|
|
16968
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17365
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#112
|
|
16969
17366
|
def html_markup_org(text); end
|
|
16970
17367
|
|
|
16971
17368
|
# Converts plaintext to pre-formatted HTML
|
|
@@ -16974,7 +17371,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16974
17371
|
# @return [String] the output HTML
|
|
16975
17372
|
# @since 0.6.0
|
|
16976
17373
|
#
|
|
16977
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17374
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#156
|
|
16978
17375
|
def html_markup_pre(text); end
|
|
16979
17376
|
|
|
16980
17377
|
# Converts RDoc formatting (SimpleMarkup) to HTML
|
|
@@ -16983,7 +17380,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16983
17380
|
# @return [String] output HTML
|
|
16984
17381
|
# @since 0.6.0
|
|
16985
17382
|
#
|
|
16986
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17383
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#146
|
|
16987
17384
|
def html_markup_rdoc(text); end
|
|
16988
17385
|
|
|
16989
17386
|
# Highlights Ruby source. Similar to {#html_syntax_highlight}, but
|
|
@@ -16994,7 +17391,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
16994
17391
|
# @return [String] the highlighted HTML
|
|
16995
17392
|
# @since 0.7.0
|
|
16996
17393
|
#
|
|
16997
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17394
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#189
|
|
16998
17395
|
def html_markup_ruby(source); end
|
|
16999
17396
|
|
|
17000
17397
|
# Converts plaintext to regular HTML
|
|
@@ -17003,7 +17400,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17003
17400
|
# @return [String] the output HTML
|
|
17004
17401
|
# @since 0.6.0
|
|
17005
17402
|
#
|
|
17006
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17403
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#164
|
|
17007
17404
|
def html_markup_text(text); end
|
|
17008
17405
|
|
|
17009
17406
|
# Converts Textile to HTML
|
|
@@ -17012,7 +17409,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17012
17409
|
# @return [String] output HTML
|
|
17013
17410
|
# @since 0.6.0
|
|
17014
17411
|
#
|
|
17015
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17412
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#128
|
|
17016
17413
|
def html_markup_textile(text); end
|
|
17017
17414
|
|
|
17018
17415
|
# Converts plaintext to strict Textile (hard breaks)
|
|
@@ -17021,7 +17418,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17021
17418
|
# @return [String] the output HTML
|
|
17022
17419
|
# @since 0.6.0
|
|
17023
17420
|
#
|
|
17024
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17421
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#138
|
|
17025
17422
|
def html_markup_textile_strict(text); end
|
|
17026
17423
|
|
|
17027
17424
|
# Syntax highlights +source+ in language +type+.
|
|
@@ -17033,12 +17430,12 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17033
17430
|
# :plain for no syntax highlighting.
|
|
17034
17431
|
# @return [String] the highlighted source
|
|
17035
17432
|
#
|
|
17036
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17433
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#209
|
|
17037
17434
|
def html_syntax_highlight(source, type = T.unsafe(nil)); end
|
|
17038
17435
|
|
|
17039
17436
|
# @return [String] unhighlighted source
|
|
17040
17437
|
#
|
|
17041
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17438
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#220
|
|
17042
17439
|
def html_syntax_highlight_plain(source); end
|
|
17043
17440
|
|
|
17044
17441
|
# Turns text into HTML using +markup+ style formatting.
|
|
@@ -17053,12 +17450,12 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17053
17450
|
|
|
17054
17451
|
# @return [String] HTMLified text as a single line (paragraphs removed)
|
|
17055
17452
|
#
|
|
17056
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17453
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#194
|
|
17057
17454
|
def htmlify_line(*args); end
|
|
17058
17455
|
|
|
17059
17456
|
# Inserts an include link while respecting inlining
|
|
17060
17457
|
#
|
|
17061
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17458
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#306
|
|
17062
17459
|
def insert_include(text, markup = T.unsafe(nil)); end
|
|
17063
17460
|
|
|
17064
17461
|
# Links to an extra file
|
|
@@ -17069,7 +17466,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17069
17466
|
# @return [String] the link to the file
|
|
17070
17467
|
# @since 0.5.5
|
|
17071
17468
|
#
|
|
17072
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17469
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#280
|
|
17073
17470
|
def link_file(filename, title = T.unsafe(nil), anchor = T.unsafe(nil)); end
|
|
17074
17471
|
|
|
17075
17472
|
# Include a file as a docstring in output
|
|
@@ -17078,7 +17475,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17078
17475
|
# @return [String] the file's contents
|
|
17079
17476
|
# @since 0.7.0
|
|
17080
17477
|
#
|
|
17081
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17478
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#292
|
|
17082
17479
|
def link_include_file(file); end
|
|
17083
17480
|
|
|
17084
17481
|
# Includes an object's docstring into output.
|
|
@@ -17087,7 +17484,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17087
17484
|
# @return [String] the object's docstring (no tags)
|
|
17088
17485
|
# @since 0.6.0
|
|
17089
17486
|
#
|
|
17090
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17487
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#301
|
|
17091
17488
|
def link_include_object(obj); end
|
|
17092
17489
|
|
|
17093
17490
|
# Links to an object with an optional title
|
|
@@ -17096,7 +17493,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17096
17493
|
# @param title [String] the title to use for the link
|
|
17097
17494
|
# @return [String] the linked object
|
|
17098
17495
|
#
|
|
17099
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17496
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#311
|
|
17100
17497
|
def link_object(obj, title = T.unsafe(nil), anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
|
|
17101
17498
|
|
|
17102
17499
|
# Links to a URL
|
|
@@ -17106,10 +17503,10 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17106
17503
|
# @param url [String] the URL to link to
|
|
17107
17504
|
# @return [String] the linked URL
|
|
17108
17505
|
#
|
|
17109
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17506
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#342
|
|
17110
17507
|
def link_url(url, title = T.unsafe(nil), params = T.unsafe(nil)); end
|
|
17111
17508
|
|
|
17112
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17509
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#410
|
|
17113
17510
|
def mtime(_file); end
|
|
17114
17511
|
|
|
17115
17512
|
# Returns the URL for an object.
|
|
@@ -17119,7 +17516,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17119
17516
|
# @param relative [Boolean] use a relative or absolute link
|
|
17120
17517
|
# @return [String] the URL location of the object
|
|
17121
17518
|
#
|
|
17122
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17519
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#409
|
|
17123
17520
|
def mtime_url(obj, anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
|
|
17124
17521
|
|
|
17125
17522
|
# Resolves any text in the form of +{Name}+ to the object specified by
|
|
@@ -17132,7 +17529,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17132
17529
|
# @param text [String] the text to resolve links in
|
|
17133
17530
|
# @return [String] HTML with linkified references
|
|
17134
17531
|
#
|
|
17135
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17532
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#235
|
|
17136
17533
|
def resolve_links(text); end
|
|
17137
17534
|
|
|
17138
17535
|
# Formats the signature of method +meth+.
|
|
@@ -17145,7 +17542,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17145
17542
|
# @param show_extras [Boolean] whether to show extra meta-data (visibility, attribute info)
|
|
17146
17543
|
# @return [String] the formatted method signature
|
|
17147
17544
|
#
|
|
17148
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17545
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#539
|
|
17149
17546
|
def signature(meth, link = T.unsafe(nil), show_extras = T.unsafe(nil), full_attr_name = T.unsafe(nil)); end
|
|
17150
17547
|
|
|
17151
17548
|
# Get the return types for a method signature.
|
|
@@ -17155,7 +17552,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17155
17552
|
# @return [String] the signature types
|
|
17156
17553
|
# @since 0.5.3
|
|
17157
17554
|
#
|
|
17158
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17555
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#502
|
|
17159
17556
|
def signature_types(meth, link = T.unsafe(nil)); end
|
|
17160
17557
|
|
|
17161
17558
|
# Returns the URL for an object.
|
|
@@ -17165,7 +17562,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17165
17562
|
# @param relative [Boolean] use a relative or absolute link
|
|
17166
17563
|
# @return [String] the URL location of the object
|
|
17167
17564
|
#
|
|
17168
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17565
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#378
|
|
17169
17566
|
def url_for(obj, anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
|
|
17170
17567
|
|
|
17171
17568
|
# Returns the URL for a specific file
|
|
@@ -17174,7 +17571,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17174
17571
|
# @param filename [String, CodeObjects::ExtraFileObject] the filename to link to
|
|
17175
17572
|
# @return [String] the URL pointing to the file
|
|
17176
17573
|
#
|
|
17177
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17574
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#417
|
|
17178
17575
|
def url_for_file(filename, anchor = T.unsafe(nil)); end
|
|
17179
17576
|
|
|
17180
17577
|
# Returns the URL for the frameset page
|
|
@@ -17182,7 +17579,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17182
17579
|
# @return [String] the URL pointing to the frames page
|
|
17183
17580
|
# @since 0.8.0
|
|
17184
17581
|
#
|
|
17185
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17582
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#444
|
|
17186
17583
|
def url_for_frameset; end
|
|
17187
17584
|
|
|
17188
17585
|
# Returns the URL for the alphabetic index page
|
|
@@ -17190,7 +17587,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17190
17587
|
# @return [String] the URL pointing to the first main page the
|
|
17191
17588
|
# user should see.
|
|
17192
17589
|
#
|
|
17193
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17590
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#460
|
|
17194
17591
|
def url_for_index; end
|
|
17195
17592
|
|
|
17196
17593
|
# Returns the URL for a list type
|
|
@@ -17199,7 +17596,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17199
17596
|
# @return [String] the URL pointing to the list
|
|
17200
17597
|
# @since 0.8.0
|
|
17201
17598
|
#
|
|
17202
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17599
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#436
|
|
17203
17600
|
def url_for_list(type); end
|
|
17204
17601
|
|
|
17205
17602
|
# Returns the URL for the main page (README or alphabetic index)
|
|
@@ -17207,7 +17604,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17207
17604
|
# @return [String] the URL pointing to the first main page the
|
|
17208
17605
|
# user should see.
|
|
17209
17606
|
#
|
|
17210
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17607
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#452
|
|
17211
17608
|
def url_for_main; end
|
|
17212
17609
|
|
|
17213
17610
|
private
|
|
@@ -17216,7 +17613,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17216
17613
|
#
|
|
17217
17614
|
# @since 0.5.3
|
|
17218
17615
|
#
|
|
17219
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17616
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#619
|
|
17220
17617
|
def convert_method_to_overload(meth); end
|
|
17221
17618
|
|
|
17222
17619
|
# Parses code block's HTML attributes in order to detect the programming
|
|
@@ -17227,7 +17624,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17227
17624
|
# @param pre_html_attrs [String, nil] HTML attribute list of +pre+ element
|
|
17228
17625
|
# @return [String, nil] detected programming language
|
|
17229
17626
|
#
|
|
17230
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17627
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#679
|
|
17231
17628
|
def detect_lang_in_codeblock_attributes(pre_html_attrs, code_html_attrs); end
|
|
17232
17629
|
|
|
17233
17630
|
# Parses code blocks out of html and performs syntax highlighting
|
|
@@ -17237,7 +17634,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17237
17634
|
# @return [String] highlighted html
|
|
17238
17635
|
# @see #html_syntax_highlight
|
|
17239
17636
|
#
|
|
17240
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17637
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#650
|
|
17241
17638
|
def parse_codeblocks(html); end
|
|
17242
17639
|
|
|
17243
17640
|
# Parses !!!lang out of codeblock, returning the codeblock language
|
|
@@ -17248,7 +17645,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17248
17645
|
# remaining source
|
|
17249
17646
|
# @since 0.7.5
|
|
17250
17647
|
#
|
|
17251
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17648
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#634
|
|
17252
17649
|
def parse_lang_for_codeblock(source); end
|
|
17253
17650
|
|
|
17254
17651
|
# Converts a set of hash options into HTML attributes for a tag
|
|
@@ -17256,7 +17653,7 @@ module YARD::Templates::Helpers::HtmlHelper
|
|
|
17256
17653
|
# @param opts [Hash{String => String}] the tag options
|
|
17257
17654
|
# @return [String] the tag attributes of an HTML tag
|
|
17258
17655
|
#
|
|
17259
|
-
# source://yard//lib/yard/templates/helpers/html_helper.rb#
|
|
17656
|
+
# source://yard//lib/yard/templates/helpers/html_helper.rb#613
|
|
17260
17657
|
def tag_attrs(opts = T.unsafe(nil)); end
|
|
17261
17658
|
|
|
17262
17659
|
# Escapes a URL
|
|
@@ -17299,26 +17696,594 @@ module YARD::Templates::Helpers::HtmlSyntaxHighlightHelper
|
|
|
17299
17696
|
# @param source [String] the Ruby source code
|
|
17300
17697
|
# @return [String] the highlighted Ruby source
|
|
17301
17698
|
#
|
|
17302
|
-
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#
|
|
17699
|
+
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#17
|
|
17303
17700
|
def html_syntax_highlight_ruby(source); end
|
|
17304
17701
|
|
|
17305
17702
|
private
|
|
17306
17703
|
|
|
17307
|
-
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#
|
|
17704
|
+
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#68
|
|
17308
17705
|
def clean_token_object(token_obj); end
|
|
17309
17706
|
|
|
17310
|
-
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#
|
|
17707
|
+
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#50
|
|
17311
17708
|
def html_syntax_highlight_ruby_legacy(source); end
|
|
17312
17709
|
|
|
17313
|
-
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#
|
|
17710
|
+
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#27
|
|
17314
17711
|
def html_syntax_highlight_ruby_ripper(source); end
|
|
17315
17712
|
end
|
|
17316
17713
|
|
|
17714
|
+
# Matches source that has already been highlighted (i.e. contains a span tag).
|
|
17715
|
+
# Used to avoid double-processing pre-highlighted HTML in the rescue clause of
|
|
17716
|
+
# {#html_syntax_highlight_ruby_ripper} and in the {HtmlHelper#parse_codeblocks} guard.
|
|
17717
|
+
#
|
|
17718
|
+
# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#12
|
|
17719
|
+
YARD::Templates::Helpers::HtmlSyntaxHighlightHelper::ALREADY_HIGHLIGHTED_RE = T.let(T.unsafe(nil), Regexp)
|
|
17720
|
+
|
|
17317
17721
|
# Namespace for markup providers
|
|
17318
17722
|
#
|
|
17319
|
-
# source://yard//lib/yard/autoload.rb#
|
|
17723
|
+
# source://yard//lib/yard/autoload.rb#289
|
|
17320
17724
|
module YARD::Templates::Helpers::Markup; end
|
|
17321
17725
|
|
|
17726
|
+
# source://yard//lib/yard/templates/helpers/markup/html_entities.rb#7
|
|
17727
|
+
module YARD::Templates::Helpers::Markup::HtmlEntities; end
|
|
17728
|
+
|
|
17729
|
+
# HTML named character references from WHATWG entities.json.
|
|
17730
|
+
#
|
|
17731
|
+
# source://yard//lib/yard/templates/helpers/markup/html_entities.rb#9
|
|
17732
|
+
YARD::Templates::Helpers::Markup::HtmlEntities::ENTITIES = T.let(T.unsafe(nil), Hash)
|
|
17733
|
+
|
|
17734
|
+
# A built-in formatter that implements a practical subset of GitHub
|
|
17735
|
+
# flavored Markdown plus common RDoc markup forms.
|
|
17736
|
+
#
|
|
17737
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#14
|
|
17738
|
+
class YARD::Templates::Helpers::Markup::HybridMarkdown
|
|
17739
|
+
# @option options
|
|
17740
|
+
# @param options [Hash] options for the formatter.
|
|
17741
|
+
# @param text [String] the Markdown text to format.
|
|
17742
|
+
# @return [HybridMarkdown] a new instance of HybridMarkdown
|
|
17743
|
+
#
|
|
17744
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#74
|
|
17745
|
+
def initialize(text, options = T.unsafe(nil)); end
|
|
17746
|
+
|
|
17747
|
+
# Returns the value of attribute from_path.
|
|
17748
|
+
#
|
|
17749
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#15
|
|
17750
|
+
def from_path; end
|
|
17751
|
+
|
|
17752
|
+
# Sets the attribute from_path
|
|
17753
|
+
#
|
|
17754
|
+
# @param value the value to set the attribute from_path to.
|
|
17755
|
+
#
|
|
17756
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#15
|
|
17757
|
+
def from_path=(_arg0); end
|
|
17758
|
+
|
|
17759
|
+
# @return [String] the formatted HTML.
|
|
17760
|
+
#
|
|
17761
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#81
|
|
17762
|
+
def to_html; end
|
|
17763
|
+
|
|
17764
|
+
private
|
|
17765
|
+
|
|
17766
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2107
|
|
17767
|
+
def append_folded_codepoint(buffer, codepoint); end
|
|
17768
|
+
|
|
17769
|
+
# @return [Boolean]
|
|
17770
|
+
#
|
|
17771
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2080
|
|
17772
|
+
def ascii_only_compat?(text); end
|
|
17773
|
+
|
|
17774
|
+
# @return [Boolean]
|
|
17775
|
+
#
|
|
17776
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1602
|
|
17777
|
+
def ascii_punctuation_char?(char); end
|
|
17778
|
+
|
|
17779
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#799
|
|
17780
|
+
def autolink_urls(text); end
|
|
17781
|
+
|
|
17782
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1544
|
|
17783
|
+
def available_delimiter_length(token); end
|
|
17784
|
+
|
|
17785
|
+
# @return [Boolean]
|
|
17786
|
+
#
|
|
17787
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#893
|
|
17788
|
+
def blank_line?(line); end
|
|
17789
|
+
|
|
17790
|
+
# @return [Boolean]
|
|
17791
|
+
#
|
|
17792
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1136
|
|
17793
|
+
def block_boundary?(line); end
|
|
17794
|
+
|
|
17795
|
+
# @return [Boolean]
|
|
17796
|
+
#
|
|
17797
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1992
|
|
17798
|
+
def blockquote_open_fence?(quoted_lines); end
|
|
17799
|
+
|
|
17800
|
+
# @return [Boolean]
|
|
17801
|
+
#
|
|
17802
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2008
|
|
17803
|
+
def blockquote_paragraph_context?(quoted_lines); end
|
|
17804
|
+
|
|
17805
|
+
# @return [Boolean]
|
|
17806
|
+
#
|
|
17807
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#958
|
|
17808
|
+
def blockquote_start?(line); end
|
|
17809
|
+
|
|
17810
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1001
|
|
17811
|
+
def code_block(text, lang = T.unsafe(nil)); end
|
|
17812
|
+
|
|
17813
|
+
# @return [Boolean]
|
|
17814
|
+
#
|
|
17815
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#924
|
|
17816
|
+
def colon_indented_code_block_start?(lines, index); end
|
|
17817
|
+
|
|
17818
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1928
|
|
17819
|
+
def consume_columns(text, columns, start_column = T.unsafe(nil), normalize_remaining = T.unsafe(nil)); end
|
|
17820
|
+
|
|
17821
|
+
# @return [Boolean]
|
|
17822
|
+
#
|
|
17823
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1763
|
|
17824
|
+
def contains_nested_link?(label, placeholders); end
|
|
17825
|
+
|
|
17826
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1521
|
|
17827
|
+
def decode_entities(text); end
|
|
17828
|
+
|
|
17829
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1855
|
|
17830
|
+
def decode_entity(entity); end
|
|
17831
|
+
|
|
17832
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1557
|
|
17833
|
+
def delimiter_flags(text, run_start, run_end, char); end
|
|
17834
|
+
|
|
17835
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2072
|
|
17836
|
+
def each_char_compat(text); end
|
|
17837
|
+
|
|
17838
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1645
|
|
17839
|
+
def escape_autolink_url(url); end
|
|
17840
|
+
|
|
17841
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1626
|
|
17842
|
+
def escape_list_marker_text(line); end
|
|
17843
|
+
|
|
17844
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1641
|
|
17845
|
+
def escape_url(url); end
|
|
17846
|
+
|
|
17847
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1007
|
|
17848
|
+
def extract_codeblock_language(text, lang = T.unsafe(nil)); end
|
|
17849
|
+
|
|
17850
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#828
|
|
17851
|
+
def extract_reference_definitions(text); end
|
|
17852
|
+
|
|
17853
|
+
# @return [Boolean]
|
|
17854
|
+
#
|
|
17855
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1056
|
|
17856
|
+
def fence_closer?(line, char, min_length); end
|
|
17857
|
+
|
|
17858
|
+
# @return [Boolean]
|
|
17859
|
+
#
|
|
17860
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#905
|
|
17861
|
+
def fenced_code_start?(line); end
|
|
17862
|
+
|
|
17863
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1487
|
|
17864
|
+
def find_braced_text_link_label_end(text, index); end
|
|
17865
|
+
|
|
17866
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1321
|
|
17867
|
+
def find_closing_bracket(text, open_index); end
|
|
17868
|
+
|
|
17869
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1339
|
|
17870
|
+
def find_matching_backtick_run(text, index, length); end
|
|
17871
|
+
|
|
17872
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1744
|
|
17873
|
+
def find_reference_label_end(text); end
|
|
17874
|
+
|
|
17875
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#728
|
|
17876
|
+
def format_emphasis(text); end
|
|
17877
|
+
|
|
17878
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#510
|
|
17879
|
+
def format_inline(text); end
|
|
17880
|
+
|
|
17881
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#795
|
|
17882
|
+
def format_strikethrough(text); end
|
|
17883
|
+
|
|
17884
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1873
|
|
17885
|
+
def h(text); end
|
|
17886
|
+
|
|
17887
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1023
|
|
17888
|
+
def heading_id(text); end
|
|
17889
|
+
|
|
17890
|
+
# @return [Boolean]
|
|
17891
|
+
#
|
|
17892
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1836
|
|
17893
|
+
def html_block_end?(type, line); end
|
|
17894
|
+
|
|
17895
|
+
# @return [Boolean]
|
|
17896
|
+
#
|
|
17897
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#962
|
|
17898
|
+
def html_block_start?(line, interrupt_paragraph = T.unsafe(nil)); end
|
|
17899
|
+
|
|
17900
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1819
|
|
17901
|
+
def html_block_type(line, interrupt_paragraph = T.unsafe(nil)); end
|
|
17902
|
+
|
|
17903
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1513
|
|
17904
|
+
def image_html(label, dest, title = T.unsafe(nil)); end
|
|
17905
|
+
|
|
17906
|
+
# @return [Boolean]
|
|
17907
|
+
#
|
|
17908
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#913
|
|
17909
|
+
def indented_code_block_start?(lines, index, previous_block_type = T.unsafe(nil)); end
|
|
17910
|
+
|
|
17911
|
+
# @return [Boolean]
|
|
17912
|
+
#
|
|
17913
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#909
|
|
17914
|
+
def indented_code_start?(line); end
|
|
17915
|
+
|
|
17916
|
+
# @return [Boolean]
|
|
17917
|
+
#
|
|
17918
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1618
|
|
17919
|
+
def indented_to?(line, indent); end
|
|
17920
|
+
|
|
17921
|
+
# @return [Boolean]
|
|
17922
|
+
#
|
|
17923
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#564
|
|
17924
|
+
def inside_angle_autolink_candidate?(text, index); end
|
|
17925
|
+
|
|
17926
|
+
# @return [Boolean]
|
|
17927
|
+
#
|
|
17928
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#952
|
|
17929
|
+
def labeled_list_start?(lines, index); end
|
|
17930
|
+
|
|
17931
|
+
# @return [Boolean]
|
|
17932
|
+
#
|
|
17933
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1981
|
|
17934
|
+
def lazy_blockquote_continuation?(quoted_lines, line); end
|
|
17935
|
+
|
|
17936
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1614
|
|
17937
|
+
def leading_columns(line); end
|
|
17938
|
+
|
|
17939
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1505
|
|
17940
|
+
def link_html(label, dest, title = T.unsafe(nil)); end
|
|
17941
|
+
|
|
17942
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1125
|
|
17943
|
+
def list_item_padding(marker); end
|
|
17944
|
+
|
|
17945
|
+
# @return [Boolean]
|
|
17946
|
+
#
|
|
17947
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#943
|
|
17948
|
+
def list_start?(line, interrupt_paragraph = T.unsafe(nil)); end
|
|
17949
|
+
|
|
17950
|
+
# @return [Boolean]
|
|
17951
|
+
#
|
|
17952
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2047
|
|
17953
|
+
def loose_list_item_continuation?(item_lines); end
|
|
17954
|
+
|
|
17955
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1535
|
|
17956
|
+
def normalize_code_span(code); end
|
|
17957
|
+
|
|
17958
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2022
|
|
17959
|
+
def normalize_heading_line(line); end
|
|
17960
|
+
|
|
17961
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2018
|
|
17962
|
+
def normalize_paragraph_line(line); end
|
|
17963
|
+
|
|
17964
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#870
|
|
17965
|
+
def normalize_reference_label(label); end
|
|
17966
|
+
|
|
17967
|
+
# @return [Boolean]
|
|
17968
|
+
#
|
|
17969
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1548
|
|
17970
|
+
def odd_match_disallowed?(opener, closer); end
|
|
17971
|
+
|
|
17972
|
+
# @return [Boolean]
|
|
17973
|
+
#
|
|
17974
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2056
|
|
17975
|
+
def open_fence_in_lines?(lines); end
|
|
17976
|
+
|
|
17977
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1029
|
|
17978
|
+
def parse_atx_heading(line); end
|
|
17979
|
+
|
|
17980
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#428
|
|
17981
|
+
def parse_blockquote(lines, index); end
|
|
17982
|
+
|
|
17983
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#87
|
|
17984
|
+
def parse_blocks(lines, index); end
|
|
17985
|
+
|
|
17986
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1043
|
|
17987
|
+
def parse_fence_opener(line); end
|
|
17988
|
+
|
|
17989
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#201
|
|
17990
|
+
def parse_fenced_code(lines, index); end
|
|
17991
|
+
|
|
17992
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#150
|
|
17993
|
+
def parse_heading(line); end
|
|
17994
|
+
|
|
17995
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#464
|
|
17996
|
+
def parse_html_block(lines, index); end
|
|
17997
|
+
|
|
17998
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#221
|
|
17999
|
+
def parse_indented_code(lines, index); end
|
|
18000
|
+
|
|
18001
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1355
|
|
18002
|
+
def parse_inline_destination(text, index, placeholders = T.unsafe(nil)); end
|
|
18003
|
+
|
|
18004
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#393
|
|
18005
|
+
def parse_labeled_list(lines, index); end
|
|
18006
|
+
|
|
18007
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#822
|
|
18008
|
+
def parse_labeled_list_line(line); end
|
|
18009
|
+
|
|
18010
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#281
|
|
18011
|
+
def parse_list(lines, index); end
|
|
18012
|
+
|
|
18013
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1070
|
|
18014
|
+
def parse_list_marker(line); end
|
|
18015
|
+
|
|
18016
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#485
|
|
18017
|
+
def parse_paragraph(lines, index); end
|
|
18018
|
+
|
|
18019
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1142
|
|
18020
|
+
def parse_reference_definition(label, definition); end
|
|
18021
|
+
|
|
18022
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1649
|
|
18023
|
+
def parse_reference_definition_block(lines, index, previous_line); end
|
|
18024
|
+
|
|
18025
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#166
|
|
18026
|
+
def parse_setext_heading(lines, index); end
|
|
18027
|
+
|
|
18028
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#252
|
|
18029
|
+
def parse_table(lines, index); end
|
|
18030
|
+
|
|
18031
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1458
|
|
18032
|
+
def parse_text_link_destination(text, index); end
|
|
18033
|
+
|
|
18034
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#238
|
|
18035
|
+
def parse_yard_indented_code(lines, index); end
|
|
18036
|
+
|
|
18037
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1803
|
|
18038
|
+
def percent_encode_url(text, allowed_re); end
|
|
18039
|
+
|
|
18040
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1451
|
|
18041
|
+
def plain_text(text); end
|
|
18042
|
+
|
|
18043
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#588
|
|
18044
|
+
def protect_autolinks(text, placeholders); end
|
|
18045
|
+
|
|
18046
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#696
|
|
18047
|
+
def protect_braced_text_links(text, placeholders); end
|
|
18048
|
+
|
|
18049
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#533
|
|
18050
|
+
def protect_code_spans(text, placeholders); end
|
|
18051
|
+
|
|
18052
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#616
|
|
18053
|
+
def protect_entities(text, placeholders); end
|
|
18054
|
+
|
|
18055
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#608
|
|
18056
|
+
def protect_escaped_characters(text, placeholders); end
|
|
18057
|
+
|
|
18058
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#620
|
|
18059
|
+
def protect_hard_breaks(text, placeholders); end
|
|
18060
|
+
|
|
18061
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#632
|
|
18062
|
+
def protect_inline_images(text, placeholders); end
|
|
18063
|
+
|
|
18064
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#642
|
|
18065
|
+
def protect_inline_links(text, placeholders); end
|
|
18066
|
+
|
|
18067
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#596
|
|
18068
|
+
def protect_raw_html(text, placeholders); end
|
|
18069
|
+
|
|
18070
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#624
|
|
18071
|
+
def protect_rdoc_images(text, placeholders); end
|
|
18072
|
+
|
|
18073
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#652
|
|
18074
|
+
def protect_reference_images(text, placeholders); end
|
|
18075
|
+
|
|
18076
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#656
|
|
18077
|
+
def protect_reference_links(text, placeholders); end
|
|
18078
|
+
|
|
18079
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#660
|
|
18080
|
+
def protect_single_word_text_links(text, placeholders); end
|
|
18081
|
+
|
|
18082
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#577
|
|
18083
|
+
def protect_yard_links(text, placeholders); end
|
|
18084
|
+
|
|
18085
|
+
# @return [Boolean]
|
|
18086
|
+
#
|
|
18087
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1582
|
|
18088
|
+
def punctuation_char?(char); end
|
|
18089
|
+
|
|
18090
|
+
# @return [Boolean]
|
|
18091
|
+
#
|
|
18092
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1718
|
|
18093
|
+
def reference_definition_context?(previous_line); end
|
|
18094
|
+
|
|
18095
|
+
# @return [Boolean]
|
|
18096
|
+
#
|
|
18097
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1527
|
|
18098
|
+
def reference_definition_continuation?(line); end
|
|
18099
|
+
|
|
18100
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1738
|
|
18101
|
+
def reference_definition_replacement_line(line, prefix); end
|
|
18102
|
+
|
|
18103
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#884
|
|
18104
|
+
def reference_image_html(alt, ref); end
|
|
18105
|
+
|
|
18106
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#875
|
|
18107
|
+
def reference_link_html(label, ref); end
|
|
18108
|
+
|
|
18109
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1204
|
|
18110
|
+
def replace_inline_constructs(text, placeholders, prefix); end
|
|
18111
|
+
|
|
18112
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#813
|
|
18113
|
+
def restore_placeholders(text, placeholders); end
|
|
18114
|
+
|
|
18115
|
+
# @return [Boolean]
|
|
18116
|
+
#
|
|
18117
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1129
|
|
18118
|
+
def same_list_type?(base, other); end
|
|
18119
|
+
|
|
18120
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1885
|
|
18121
|
+
def scan_leading_columns(text); end
|
|
18122
|
+
|
|
18123
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1905
|
|
18124
|
+
def scan_padding_columns(text, index, start_column); end
|
|
18125
|
+
|
|
18126
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1252
|
|
18127
|
+
def scan_reference_constructs(text, placeholders, kind); end
|
|
18128
|
+
|
|
18129
|
+
# @return [Boolean]
|
|
18130
|
+
#
|
|
18131
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#901
|
|
18132
|
+
def setext_underline_line?(line); end
|
|
18133
|
+
|
|
18134
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2026
|
|
18135
|
+
def split_blockquote_prefix(line); end
|
|
18136
|
+
|
|
18137
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1881
|
|
18138
|
+
def split_lines(text); end
|
|
18139
|
+
|
|
18140
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1726
|
|
18141
|
+
def split_reference_container_prefix(line); end
|
|
18142
|
+
|
|
18143
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#976
|
|
18144
|
+
def split_table_row(line); end
|
|
18145
|
+
|
|
18146
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#817
|
|
18147
|
+
def store_placeholder(placeholders, html); end
|
|
18148
|
+
|
|
18149
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2042
|
|
18150
|
+
def strip_blockquote_marker(line); end
|
|
18151
|
+
|
|
18152
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1064
|
|
18153
|
+
def strip_fenced_indent(line, indent); end
|
|
18154
|
+
|
|
18155
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1622
|
|
18156
|
+
def strip_list_item_indent(line, content_indent); end
|
|
18157
|
+
|
|
18158
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1014
|
|
18159
|
+
def strip_trailing_punctuation(url); end
|
|
18160
|
+
|
|
18161
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#980
|
|
18162
|
+
def table_alignment(cell); end
|
|
18163
|
+
|
|
18164
|
+
# @return [Boolean]
|
|
18165
|
+
#
|
|
18166
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#971
|
|
18167
|
+
def table_row?(line); end
|
|
18168
|
+
|
|
18169
|
+
# @return [Boolean]
|
|
18170
|
+
#
|
|
18171
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#966
|
|
18172
|
+
def table_start?(lines, index); end
|
|
18173
|
+
|
|
18174
|
+
# @return [Boolean]
|
|
18175
|
+
#
|
|
18176
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#897
|
|
18177
|
+
def thematic_break?(line); end
|
|
18178
|
+
|
|
18179
|
+
# @return [Boolean]
|
|
18180
|
+
#
|
|
18181
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1791
|
|
18182
|
+
def unclosed_reference_title?(text); end
|
|
18183
|
+
|
|
18184
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1877
|
|
18185
|
+
def unescape_markdown_punctuation(text); end
|
|
18186
|
+
|
|
18187
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2096
|
|
18188
|
+
def unicode_casefold_compat(text); end
|
|
18189
|
+
|
|
18190
|
+
# @return [Boolean]
|
|
18191
|
+
#
|
|
18192
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1588
|
|
18193
|
+
def unicode_symbol_char?(char); end
|
|
18194
|
+
|
|
18195
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#989
|
|
18196
|
+
def unindent(lines); end
|
|
18197
|
+
|
|
18198
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#997
|
|
18199
|
+
def unindent_indented_code(lines); end
|
|
18200
|
+
|
|
18201
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2088
|
|
18202
|
+
def utf8_bytes(char); end
|
|
18203
|
+
|
|
18204
|
+
# @return [Boolean]
|
|
18205
|
+
#
|
|
18206
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1578
|
|
18207
|
+
def whitespace_char?(char); end
|
|
18208
|
+
|
|
18209
|
+
# @return [Boolean]
|
|
18210
|
+
#
|
|
18211
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#935
|
|
18212
|
+
def yard_indented_code_start?(lines, index); end
|
|
18213
|
+
end
|
|
18214
|
+
|
|
18215
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#17
|
|
18216
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::ATX_HEADING_RE = T.let(T.unsafe(nil), Regexp)
|
|
18217
|
+
|
|
18218
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#68
|
|
18219
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::AUTOLINK_RE = T.let(T.unsafe(nil), Regexp)
|
|
18220
|
+
|
|
18221
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#28
|
|
18222
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::BLOCKQUOTE_RE = T.let(T.unsafe(nil), Regexp)
|
|
18223
|
+
|
|
18224
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#63
|
|
18225
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::CODE_LANG_RE = T.let(T.unsafe(nil), Regexp)
|
|
18226
|
+
|
|
18227
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#61
|
|
18228
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::ENTITY_RE = T.let(T.unsafe(nil), Regexp)
|
|
18229
|
+
|
|
18230
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#66
|
|
18231
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::ESCAPABLE_CHARS_RE = T.let(T.unsafe(nil), Regexp)
|
|
18232
|
+
|
|
18233
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#20
|
|
18234
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::FENCE_RE = T.let(T.unsafe(nil), Regexp)
|
|
18235
|
+
|
|
18236
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#29
|
|
18237
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_BLOCK_RE = T.let(T.unsafe(nil), Regexp)
|
|
18238
|
+
|
|
18239
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#41
|
|
18240
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_BLOCK_TAGS = T.let(T.unsafe(nil), Array)
|
|
18241
|
+
|
|
18242
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#48
|
|
18243
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_TAG_RE = T.let(T.unsafe(nil), Regexp)
|
|
18244
|
+
|
|
18245
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#26
|
|
18246
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::LABEL_LIST_BRACKET_RE = T.let(T.unsafe(nil), Regexp)
|
|
18247
|
+
|
|
18248
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#27
|
|
18249
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::LABEL_LIST_COLON_RE = T.let(T.unsafe(nil), Regexp)
|
|
18250
|
+
|
|
18251
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#24
|
|
18252
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::ORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
|
|
18253
|
+
|
|
18254
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#65
|
|
18255
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::PLACEHOLDER_RE = T.let(T.unsafe(nil), Regexp)
|
|
18256
|
+
|
|
18257
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#67
|
|
18258
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_ESCAPED_CAPITALIZED_CROSSREF_RE = T.let(T.unsafe(nil), Regexp)
|
|
18259
|
+
|
|
18260
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#18
|
|
18261
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_HEADING_RE = T.let(T.unsafe(nil), Regexp)
|
|
18262
|
+
|
|
18263
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#25
|
|
18264
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_ORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
|
|
18265
|
+
|
|
18266
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#64
|
|
18267
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::REFERENCE_DEF_START_RE = T.let(T.unsafe(nil), Regexp)
|
|
18268
|
+
|
|
18269
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#19
|
|
18270
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::SETEXT_HEADING_RE = T.let(T.unsafe(nil), Regexp)
|
|
18271
|
+
|
|
18272
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#22
|
|
18273
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::TABLE_SEPARATOR_RE = T.let(T.unsafe(nil), Regexp)
|
|
18274
|
+
|
|
18275
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#69
|
|
18276
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::TAB_WIDTH = T.let(T.unsafe(nil), Integer)
|
|
18277
|
+
|
|
18278
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#21
|
|
18279
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::THEMATIC_BREAK_RE = T.let(T.unsafe(nil), Regexp)
|
|
18280
|
+
|
|
18281
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#23
|
|
18282
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::UNORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
|
|
18283
|
+
|
|
18284
|
+
# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#62
|
|
18285
|
+
YARD::Templates::Helpers::Markup::HybridMarkdown::YARD_LINK_RE = T.let(T.unsafe(nil), Regexp)
|
|
18286
|
+
|
|
17322
18287
|
# source://yard//lib/yard/templates/helpers/markup/rdoc_markdown.rb#13
|
|
17323
18288
|
class YARD::Templates::Helpers::Markup::RDocMarkdown < ::YARD::Templates::Helpers::Markup::RDocMarkup
|
|
17324
18289
|
# @return [RDocMarkdown] a new instance of RDocMarkdown
|
|
@@ -17418,7 +18383,7 @@ module YARD::Templates::Helpers::MarkupHelper
|
|
|
17418
18383
|
#
|
|
17419
18384
|
# @return [Boolean] whether the markup provider was successfully loaded.
|
|
17420
18385
|
#
|
|
17421
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18386
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#89
|
|
17422
18387
|
def load_markup_provider(type = T.unsafe(nil)); end
|
|
17423
18388
|
|
|
17424
18389
|
# Gets the markup provider class/module constant for a markup type
|
|
@@ -17427,7 +18392,7 @@ module YARD::Templates::Helpers::MarkupHelper
|
|
|
17427
18392
|
# @param type [Symbol] the markup type (:rdoc, :markdown, etc.)
|
|
17428
18393
|
# @return [Class] the markup class
|
|
17429
18394
|
#
|
|
17430
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18395
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#160
|
|
17431
18396
|
def markup_class(type = T.unsafe(nil)); end
|
|
17432
18397
|
|
|
17433
18398
|
# Strips any shebang lines on the file contents that pertain to
|
|
@@ -17437,7 +18402,7 @@ module YARD::Templates::Helpers::MarkupHelper
|
|
|
17437
18402
|
# @return [String] the file contents minus any preprocessing tags
|
|
17438
18403
|
# @since 0.6.0
|
|
17439
18404
|
#
|
|
17440
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18405
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#151
|
|
17441
18406
|
def markup_file_contents(contents); end
|
|
17442
18407
|
|
|
17443
18408
|
# Checks for a shebang or looks at the file extension to determine
|
|
@@ -17456,7 +18421,7 @@ module YARD::Templates::Helpers::MarkupHelper
|
|
|
17456
18421
|
# @see MARKUP_EXTENSIONS
|
|
17457
18422
|
# @since 0.6.0
|
|
17458
18423
|
#
|
|
17459
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18424
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#135
|
|
17460
18425
|
def markup_for_file(contents, filename); end
|
|
17461
18426
|
|
|
17462
18427
|
# Gets the markup provider name for a markup type
|
|
@@ -17465,7 +18430,7 @@ module YARD::Templates::Helpers::MarkupHelper
|
|
|
17465
18430
|
# @param type [Symbol] the markup type (:rdoc, :markdown, etc.)
|
|
17466
18431
|
# @return [Symbol] the markup provider name (usually the gem name of the library)
|
|
17467
18432
|
#
|
|
17468
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18433
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#170
|
|
17469
18434
|
def markup_provider(type = T.unsafe(nil)); end
|
|
17470
18435
|
|
|
17471
18436
|
class << self
|
|
@@ -17498,13 +18463,13 @@ end
|
|
|
17498
18463
|
#
|
|
17499
18464
|
# @since 0.6.0
|
|
17500
18465
|
#
|
|
17501
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18466
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#63
|
|
17502
18467
|
YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS = T.let(T.unsafe(nil), Hash)
|
|
17503
18468
|
|
|
17504
18469
|
# Contains the Regexp object that matches the shebang line of extra
|
|
17505
18470
|
# files to detect the markup type.
|
|
17506
18471
|
#
|
|
17507
|
-
# source://yard//lib/yard/templates/helpers/markup_helper.rb#
|
|
18472
|
+
# source://yard//lib/yard/templates/helpers/markup_helper.rb#76
|
|
17508
18473
|
YARD::Templates::Helpers::MarkupHelper::MARKUP_FILE_SHEBANG = T.let(T.unsafe(nil), Regexp)
|
|
17509
18474
|
|
|
17510
18475
|
# The default list of markup providers for each markup type
|