diff options
author | scott Chacon <schacon@agadorsparticus.(none)> | 2007-11-11 17:59:18 -0800 |
---|---|---|
committer | scott Chacon <schacon@agadorsparticus.(none)> | 2007-11-11 17:59:18 -0800 |
commit | 646304a6e7c3b2c442a0a7db995629e7009c3a14 (patch) | |
tree | 0475bc78d2f805a36c91a898804e099634d8c54a /doc/classes/Git/Diff.html | |
parent | 31b4f2b80616f570c83ed62d20f8b14ec5ba425b (diff) | |
download | third_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.tar.gz third_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.tar.xz third_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.zip |
added documentation and a license file
Diffstat (limited to 'doc/classes/Git/Diff.html')
-rw-r--r-- | doc/classes/Git/Diff.html | 419 |
1 files changed, 419 insertions, 0 deletions
diff --git a/doc/classes/Git/Diff.html b/doc/classes/Git/Diff.html new file mode 100644 index 0000000..a1d441e --- /dev/null +++ b/doc/classes/Git/Diff.html @@ -0,0 +1,419 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>Class: Git::Diff</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + <meta http-equiv="Content-Script-Type" content="text/javascript" /> + <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> + <script type="text/javascript"> + // <![CDATA[ + + function popupCode( url ) { + window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") + } + + function toggleCode( id ) { + if ( document.getElementById ) + elem = document.getElementById( id ); + else if ( document.all ) + elem = eval( "document.all." + id ); + else + return false; + + elemStyle = elem.style; + + if ( elemStyle.display != "block" ) { + elemStyle.display = "block" + } else { + elemStyle.display = "none" + } + + return true; + } + + // Make codeblocks hidden by default + document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) + + // ]]> + </script> + +</head> +<body> + + + + <div id="classHeader"> + <table class="header-table"> + <tr class="top-aligned-row"> + <td><strong>Class</strong></td> + <td class="class-name-in-header">Git::Diff</td> + </tr> + <tr class="top-aligned-row"> + <td><strong>In:</strong></td> + <td> + <a href="../../files/lib/git/diff_rb.html"> + lib/git/diff.rb + </a> + <br /> + </td> + </tr> + + <tr class="top-aligned-row"> + <td><strong>Parent:</strong></td> + <td> + <a href="Object.html"> + Object + </a> + </td> + </tr> + </table> + </div> + <!-- banner header --> + + <div id="bodyContent"> + + + + <div id="contextContent"> + + <div id="description"> + <p> +object that holds the last X commits on given branch +</p> + + </div> + + + </div> + + <div id="method-list"> + <h3 class="section-bar">Methods</h3> + + <div class="name-list"> + <a href="#M000143">[]</a> + <a href="#M000138">deletions</a> + <a href="#M000144">each</a> + <a href="#M000139">insertions</a> + <a href="#M000137">lines</a> + <a href="#M000134">new</a> + <a href="#M000141">patch</a> + <a href="#M000135">path</a> + <a href="#M000136">size</a> + <a href="#M000140">stats</a> + <a href="#M000142">to_s</a> + </div> + </div> + + </div> + + + <!-- if includes --> + <div id="includes"> + <h3 class="section-bar">Included Modules</h3> + + <div id="includes-list"> + <span class="include-name">Enumerable</span> + </div> + </div> + + <div id="section"> + + <div id="class-list"> + <h3 class="section-bar">Classes and Modules</h3> + + Class <a href="Diff/DiffFile.html" class="link">Git::Diff::DiffFile</a><br /> + + </div> + + + + + + + + <!-- if method_list --> + <div id="methods"> + <h3 class="section-bar">Public Class methods</h3> + + <div id="method-M000134" class="method-detail"> + <a name="M000134"></a> + + <div class="method-heading"> + <a href="#M000134" class="method-signature"> + <span class="method-name">new</span><span class="method-args">(base, from = nil, to = nil)</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000134-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000134-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 16</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">from</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">to</span> = <span class="ruby-keyword kw">nil</span>) + <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span> + <span class="ruby-ivar">@from</span> = <span class="ruby-identifier">from</span>.<span class="ruby-identifier">to_s</span> + <span class="ruby-ivar">@to</span> = <span class="ruby-identifier">to</span>.<span class="ruby-identifier">to_s</span> + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <h3 class="section-bar">Public Instance methods</h3> + + <div id="method-M000143" class="method-detail"> + <a name="M000143"></a> + + <div class="method-heading"> + <a href="#M000143" class="method-signature"> + <span class="method-name">[]</span><span class="method-args">(key)</span> + </a> + </div> + + <div class="method-description"> + <p> +enumerable methods +</p> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000143-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000143-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 61</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>) + <span class="ruby-identifier">process_full</span> + <span class="ruby-ivar">@full_diff_files</span>.<span class="ruby-identifier">assoc</span>(<span class="ruby-identifier">key</span>)[<span class="ruby-value">1</span>] + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000138" class="method-detail"> + <a name="M000138"></a> + + <div class="method-heading"> + <a href="#M000138" class="method-signature"> + <span class="method-name">deletions</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000138-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000138-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 37</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">deletions</span> + <span class="ruby-identifier">cache_stats</span> + <span class="ruby-ivar">@stats</span>[<span class="ruby-identifier">:total</span>][<span class="ruby-identifier">:deletions</span>] + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000144" class="method-detail"> + <a name="M000144"></a> + + <div class="method-heading"> + <a href="#M000144" class="method-signature"> + <span class="method-name">each</span><span class="method-args">() {|file[1]| ...}</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000144-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000144-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 66</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span> + <span class="ruby-identifier">process_full</span> + <span class="ruby-ivar">@full_diff_files</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> + <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">file</span>[<span class="ruby-value">1</span>] + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000139" class="method-detail"> + <a name="M000139"></a> + + <div class="method-heading"> + <a href="#M000139" class="method-signature"> + <span class="method-name">insertions</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000139-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000139-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 42</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">insertions</span> + <span class="ruby-identifier">cache_stats</span> + <span class="ruby-ivar">@stats</span>[<span class="ruby-identifier">:total</span>][<span class="ruby-identifier">:insertions</span>] + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000137" class="method-detail"> + <a name="M000137"></a> + + <div class="method-heading"> + <a href="#M000137" class="method-signature"> + <span class="method-name">lines</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000137-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000137-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 32</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lines</span> + <span class="ruby-identifier">cache_stats</span> + <span class="ruby-ivar">@stats</span>[<span class="ruby-identifier">:total</span>][<span class="ruby-identifier">:lines</span>] + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000141" class="method-detail"> + <a name="M000141"></a> + + <div class="method-heading"> + <a href="#M000141" class="method-signature"> + <span class="method-name">patch</span><span class="method-args">(file = nil)</span> + </a> + </div> + + <div class="method-description"> + <p> +if file is provided and is writable, it will write the patch into the file +</p> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000141-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000141-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 53</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">patch</span>(<span class="ruby-identifier">file</span> = <span class="ruby-keyword kw">nil</span>) + <span class="ruby-identifier">cache_full</span> + <span class="ruby-ivar">@full_diff</span> + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000135" class="method-detail"> + <a name="M000135"></a> + + <div class="method-heading"> + <a href="#M000135" class="method-signature"> + <span class="method-name">path</span><span class="method-args">(path)</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000135-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000135-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 22</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">path</span>(<span class="ruby-identifier">path</span>) + <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span> + <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span> + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000136" class="method-detail"> + <a name="M000136"></a> + + <div class="method-heading"> + <a href="#M000136" class="method-signature"> + <span class="method-name">size</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000136-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000136-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 27</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">size</span> + <span class="ruby-identifier">cache_stats</span> + <span class="ruby-ivar">@stats</span>[<span class="ruby-identifier">:total</span>][<span class="ruby-identifier">:files</span>] + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000140" class="method-detail"> + <a name="M000140"></a> + + <div class="method-heading"> + <a href="#M000140" class="method-signature"> + <span class="method-name">stats</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000140-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000140-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git/diff.rb, line 47</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span> + <span class="ruby-identifier">cache_stats</span> + <span class="ruby-ivar">@stats</span> + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000142" class="method-detail"> + <a name="M000142"></a> + + <div class="method-heading"> + <span class="method-name">to_s</span><span class="method-args">(file = nil)</span> + </div> + + <div class="method-description"> + <p> +Alias for <a href="Diff.html#M000141">patch</a> +</p> + </div> + </div> + + + </div> + + + </div> + + +<div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> +</div> + +</body> +</html>
\ No newline at end of file |