archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-23 13:04:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[ruby/rdoc] Print warnings for rdoc-ref links that can't be resolved

Browse source 
(https://github.com/ruby/rdoc/pull/1241)

4a5206ae56
This commit is contained in:
Stan Lo 2024-12-17 03:34:56 +08:00 • committed by git
parent 80b8feb929
commit a6fd6cb72f
4 changed files with 80 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

34
lib/rdoc/markup/to_html_crossref.rb
View file

@ -58,7 +58,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
# Creates a link to the reference +name+ if the name exists. If +text+ is
# given it is used as the link text, otherwise +name+ is used.
def cross_reference name, text = nil, code = true
def cross_reference name, text = nil, code = true, rdoc_ref: false
lookup = name
name = name[1..-1] unless @show_hash if name[0, 1] == '#'
@ -70,7 +70,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
text ||= name
end
link lookup, text, code
link lookup, text, code, rdoc_ref: rdoc_ref
end
##
@ -92,7 +92,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
return name if name =~ /\A[a-z]*\z/
end
cross_reference name
cross_reference name, rdoc_ref: false
end
##
@ -100,9 +100,14 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
# handle other schemes.
def handle_regexp_HYPERLINK target
return cross_reference $' if target.text =~ /\Ardoc-ref:/
url = target.text
super
case url
when /\Ardoc-ref:/
cross_reference $', rdoc_ref: true
else
super
end
end
##
@ -117,8 +122,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
url = target.text
case url
when /\Ardoc-ref:/ then
cross_reference $'
when /\Ardoc-ref:/
cross_reference $', rdoc_ref: true
else
super
end
@ -129,16 +134,18 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
# RDoc::Markup::ToHtml to handle other schemes.
def gen_url url, text
return super unless url =~ /\Ardoc-ref:/
name = $'
cross_reference name, text, name == text
if url =~ /\Ardoc-ref:/
name = $'
cross_reference name, text, name == text, rdoc_ref: true
else
super
end
end
##
# Creates an HTML link to +name+ with the given +text+.
def link name, text, code = true
def link name, text, code = true, rdoc_ref: false
if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
name = $1
label = $'
@ -148,6 +155,9 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
case ref
when String then
if rdoc_ref && @options.warn_missing_rdoc_ref
puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{text}`"
end
ref
else
path = ref ? ref.as_href(@from_path) : +""