Added some doc

Author: lyrixx

doc/api.rst

@@ -11,6 +11,7 @@ API documentation
    api/commit
    api/blame
    api/blob
+   api/branch
    api/tree
    api/log
    api/diff

doc/api/branch.rst

@@ -0,0 +1,16 @@
+Branch
+======
+
+To access a *Branch*, starting from a repository object:
+
+.. code-block:: php
+
+    $repository = new Gitonomy\Git\Repository('/path/to/repository');
+    $branch = $repository->getReferences()->getBranch('master');
+
+You can check is the branch is a local or remote one:
+
+.. code-block:: php
+
+    $branch->isLocal();
+    $branch->isRemote();

doc/api/commit.rst

@@ -94,12 +94,33 @@ To access the message, you can use the *getMessage* method:
     $commit->getMessage();
 
 For your convenience, this library provides a shortcut method to keep only the
-first line or first 80 characters if the first line is too long:
+first line or first 50 characters if the first line is too long:
 
 .. code-block:: php
 
     $commit->getShortMessage();
 
+You can customize it like this:
+
+.. code-block:: php
+
+    $commit->getShortMessage(45, true, '.');
+
+* The first parameter is the max length of the message.
+* The second parameter determine if the last word should be cut or preserved
+* The third parameter is the separator
+
+There are also two other methods for your convenience:
+
+.. code-block:: php
+
+    // The first line
+    $commit->getSubjectMessage();
+
+    // The body (rest of the message)
+    $commit->getBodyMessage();
+
+
 Diff of a commit
 ----------------
 
@@ -137,3 +158,12 @@ Here is a very straightforward example:
     echo"  Author: ".$last->getAuthorName()."\n";
     echo"    Date: ".$last->getAuthorDate()->format('d/m/Y')."\n";
     echo" Message: ".$last->getMessage();
+
+Find every branches containing a commit
+---------------------------------------
+
+.. code-block:: php
+
+    $branches       = $commit->getIncludingBranches($includeLocalBranches, $includeRemoteBranches);
+    $localBranches  = $commit->getIncludingBranches(true, false);
+    $remoteBranches = $commit->getIncludingBranches(false, true);

doc/api/references.rst

@@ -23,17 +23,21 @@ If you want to access all branches or all tags:
 
 .. code-block:: php
 
-    $branches = $repository->getBranches();
-    $tags     = $repository->getTags();
-    $all      = $repository->getAll();
+    $branches       = $repository->getBranches();
+    $localBranches  = $repository->getLocalBranches();
+    $remoteBranches = $repository->getRemoteBranches();
+    $tags           = $repository->getTags();
+    $all            = $repository->getAll();
 
 To get a given branch or tag, call *getBranch* or *getTag* on the
 *ReferenceBag*. Those methods return *Branch* and *Tag* objects:
 
 .. code-block:: php
 
-    $master = $references->getBranch('master');
-    $v0_1 = $references->getTag('0.1');
+    $master  = $references->getBranch('master');
+    $feat123 = $references->getLocalBranch('feat123');
+    $feat456 = $references->getRemoteBranch('origin/feat456');
+    $v0_1    = $references->getTag('0.1');
 
 If the reference cannot be resolved, a *ReferenceNotFoundException* will be
 thrown.