Skip to content

Make methods and attributes linkable #1189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2024
Merged

Make methods and attributes linkable #1189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
692280d
Use the same color for both class/module and method highlight
st0012 Oct 10, 2024
f576e5f
Make methods and attributes linkable
st0012 Sep 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions lib/rdoc/generator/template/darkfish/class.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,10 @@
<%- attributes.each do |attrib| -%>
<div id="<%= attrib.aref %>" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name"><%= h attrib.name %></span><span
class="attribute-access-type">[<%= attrib.rw %>]</span>
<a href="#<%= attrib.aref %>" title="Link to this attribute">
<span class="method-name"><%= h attrib.name %></span>
<span class="attribute-access-type">[<%= attrib.rw %>]</span>
</a>
</div>

<div class="method-description">
Expand Down Expand Up @@ -103,21 +105,27 @@
<%- if (call_seq = method.call_seq) then -%>
<%- call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
<div class="method-heading">
<span class="method-callseq">
<%= h(call_seq.strip.
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-callseq">
<%= h(call_seq.strip.
gsub( /^\w+\./m, '')).
gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
</span>
</span>
</a>
</div>
<%- end -%>
<%- elsif method.has_call_seq? then -%>
<div class="method-heading">
<span class="method-name"><%= h method.name %></span>
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-name"><%= h method.name %></span>
</a>
</div>
<%- else -%>
<div class="method-heading">
<span class="method-name"><%= h method.name %></span>
<span class="method-args"><%= h method.param_seq %></span>
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-name"><%= h method.name %></span>
<span class="method-args"><%= h method.param_seq %></span>
</a>
</div>
<%- end -%>
</div>
Expand Down
15 changes: 13 additions & 2 deletions lib/rdoc/generator/template/darkfish/css/rdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ h4:target,
h5:target,
h6:target {
margin-left: -10px;
border-left: 10px solid #f1edba;
border-left: 10px solid var(--source-code-background-color);
}

/* 4. Links */
Expand Down Expand Up @@ -631,6 +631,18 @@ main .method-heading {
color: var(--text-color);
}

main .method-heading::after {
content: '¶';
position: absolute;
visibility: hidden;
color: var(--secondary-color);
font-size: 0.5em;
}

main .method-heading:hover::after {
visibility: visible;
}

main .method-controls {
line-height: 20px;
float: right;
Expand Down Expand Up @@ -663,7 +675,6 @@ main #attribute-method-details .method-detail:hover {
}
main .attribute-access-type {
text-transform: uppercase;
padding: 0 1em;
}
/* @end */

Expand Down