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.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.html')
-rw-r--r-- | doc/classes/Git.html | 284 |
1 files changed, 284 insertions, 0 deletions
diff --git a/doc/classes/Git.html b/doc/classes/Git.html new file mode 100644 index 0000000..3ddaacf --- /dev/null +++ b/doc/classes/Git.html @@ -0,0 +1,284 @@ +<?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>Module: Git</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>Module</strong></td> + <td class="class-name-in-header">Git</td> + </tr> + <tr class="top-aligned-row"> + <td><strong>In:</strong></td> + <td> + <a href="../files/lib/git/base_rb.html"> + lib/git/base.rb + </a> + <br /> + <a href="../files/lib/git/branch_rb.html"> + lib/git/branch.rb + </a> + <br /> + <a href="../files/lib/git/branches_rb.html"> + lib/git/branches.rb + </a> + <br /> + <a href="../files/lib/git/diff_rb.html"> + lib/git/diff.rb + </a> + <br /> + <a href="../files/lib/git/index_rb.html"> + lib/git/index.rb + </a> + <br /> + <a href="../files/lib/git/lib_rb.html"> + lib/git/lib.rb + </a> + <br /> + <a href="../files/lib/git/log_rb.html"> + lib/git/log.rb + </a> + <br /> + <a href="../files/lib/git/object_rb.html"> + lib/git/object.rb + </a> + <br /> + <a href="../files/lib/git/path_rb.html"> + lib/git/path.rb + </a> + <br /> + <a href="../files/lib/git/remote_rb.html"> + lib/git/remote.rb + </a> + <br /> + <a href="../files/lib/git/repository_rb.html"> + lib/git/repository.rb + </a> + <br /> + <a href="../files/lib/git/status_rb.html"> + lib/git/status.rb + </a> + <br /> + <a href="../files/lib/git/working_directory_rb.html"> + lib/git/working_directory.rb + </a> + <br /> + <a href="../files/lib/git_rb.html"> + lib/git.rb + </a> + <br /> + </td> + </tr> + + </table> + </div> + <!-- banner header --> + + <div id="bodyContent"> + + + + <div id="contextContent"> + + + + </div> + + <div id="method-list"> + <h3 class="section-bar">Methods</h3> + + <div class="name-list"> + <a href="#M000001">bare</a> + <a href="#M000004">clone</a> + <a href="#M000003">init</a> + <a href="#M000002">open</a> + </div> + </div> + + </div> + + + <!-- if includes --> + + <div id="section"> + + <div id="class-list"> + <h3 class="section-bar">Classes and Modules</h3> + + Class <a href="Git/Base.html" class="link">Git::Base</a><br /> +Class <a href="Git/Branch.html" class="link">Git::Branch</a><br /> +Class <a href="Git/Branches.html" class="link">Git::Branches</a><br /> +Class <a href="Git/Diff.html" class="link">Git::Diff</a><br /> +Class <a href="Git/GitExecuteError.html" class="link">Git::GitExecuteError</a><br /> +Class <a href="Git/GitTagNameDoesNotExist.html" class="link">Git::GitTagNameDoesNotExist</a><br /> +Class <a href="Git/Index.html" class="link">Git::Index</a><br /> +Class <a href="Git/Lib.html" class="link">Git::Lib</a><br /> +Class <a href="Git/Log.html" class="link">Git::Log</a><br /> +Class <a href="Git/Object.html" class="link">Git::Object</a><br /> +Class <a href="Git/Path.html" class="link">Git::Path</a><br /> +Class <a href="Git/Remote.html" class="link">Git::Remote</a><br /> +Class <a href="Git/Repository.html" class="link">Git::Repository</a><br /> +Class <a href="Git/Status.html" class="link">Git::Status</a><br /> +Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a><br /> + + </div> + + + + + + + + <!-- if method_list --> + <div id="methods"> + <h3 class="section-bar">Public Class methods</h3> + + <div id="method-M000001" class="method-detail"> + <a name="M000001"></a> + + <div class="method-heading"> + <a href="#M000001" class="method-signature"> + <span class="method-name">bare</span><span class="method-args">(git_dir)</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000001-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000001-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git.rb, line 34</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>) + <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>) + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000004" class="method-detail"> + <a name="M000004"></a> + + <div class="method-heading"> + <a href="#M000004" class="method-signature"> + <span class="method-name">clone</span><span class="method-args">(repository, name, options = {})</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000004-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000004-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git.rb, line 46</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {}) + <span class="ruby-constant">Base</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>) + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000003" class="method-detail"> + <a name="M000003"></a> + + <div class="method-heading"> + <a href="#M000003" class="method-signature"> + <span class="method-name">init</span><span class="method-args">(working_dir = '.', options = {})</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000003-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000003-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git.rb, line 42</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span> = <span class="ruby-value str">'.'</span>, <span class="ruby-identifier">options</span> = {}) + <span class="ruby-constant">Base</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>) + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </div> + </div> + + <div id="method-M000002" class="method-detail"> + <a name="M000002"></a> + + <div class="method-heading"> + <a href="#M000002" class="method-signature"> + <span class="method-name">open</span><span class="method-args">(working_dir, options = {})</span> + </a> + </div> + + <div class="method-description"> + <p><a class="source-toggle" href="#" + onclick="toggleCode('M000002-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000002-source"> +<pre> +<span class="ruby-comment cmt"># File lib/git.rb, line 38</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span> = {}) + <span class="ruby-constant">Base</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>) + <span class="ruby-keyword kw">end</span> +</pre> + </div> + </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 |