Document render_issue_tooltip

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@4166 e93f8b46-1217-0410-a6f0-8f06a7374b81

Document render_issue_tooltip
git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@4166 e93f8b46-1217-0410-a6f0-8f06a7374b81
55fbf683 · Eric Davis · a09a3940 · 55fbf683
Commit 55fbf683 authored Sep 20, 2010 by Eric Davis
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 1 deletion

issues_helper.rb app/helpers/issues_helper.rb +10 -1

No files found.
--- a/app/helpers/issues_helper.rb
+++ b/app/helpers/issues_helper.rb
@@ -28,7 +28,16 @@ module IssuesHelper
      ancestors << issue unless issue.leaf?
    end
  end
-  
+
+  # Renders a HTML/CSS tooltip
+  #
+  # To use, a trigger div is needed.  This is a div with the class of "tooltip"
+  # that contains this method wrapped in a span with the class of "tip"
+  #
+  #    <div class="tooltip"><%= link_to_issue(issue) %>
+  #      <span class="tip"><%= render_issue_tooltip(issue) %></span>
+  #    </div>
+  #
  def render_issue_tooltip(issue)
    @cached_label_status ||= l(:field_status)
    @cached_label_start_date ||= l(:field_start_date)