Anonymous avatar Anonymous committed 7404759

* Much better set of documentation!

Comments (0)

Files changed (588)

Trunk/Documentation/API/Docbook/default/default.xml

-<sect1 id="package.versioncontrol.hg">
- <title>Hg</title>
- <refentry id="package.versioncontrol.hg.versioncontrol-hg-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg</classname>
-   </refname>
-   <refpurpose>Assumes to be working on a local filesystem repository</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Assumes to be working on a local filesystem repository</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>VersionControl_Hg</para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.versioncontrol-hg.--construct;
-&package.versioncontrol.hg.versioncontrol-hg.getexecutable;
-&package.versioncontrol.hg.versioncontrol-hg.getrepository;
-&package.versioncontrol.hg.versioncontrol-hg.setexecutable;
-&package.versioncontrol.hg.versioncontrol-hg.setrepository;
-&package.versioncontrol.hg.versioncontrol-hg.--call;
-&package.versioncontrol.hg.versioncontrol-hg.--tostring;
- <refentry id="package.versioncontrol.hg.versioncontrol-hg-commandproxy-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_CommandProxy</classname>
-   </refname>
-   <refpurpose>
-    Instantiates the Mercurial command and passes an instance of
-    VersionControl_Hg into the constructor of each command.
-</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>
-    Instantiates the Mercurial command and passes an instance of
-    VersionControl_Hg into the constructor of each command.
-</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_CommandProxy</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>VersionControl_Hg_CommandProxy</para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.versioncontrol-hg-commandproxy.--construct;
-&package.versioncontrol.hg.versioncontrol-hg-commandproxy.getcommand;
-&package.versioncontrol.hg.versioncontrol-hg-commandproxy.setcommand;
-&package.versioncontrol.hg.versioncontrol-hg-commandproxy.--call;
- <refentry id="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Command_Abstract</classname>
-   </refname>
-   <refpurpose>
-    implements the following global options:  -I --include    include names
-    matching the given patterns  -X --exclude    exclude names matching the
-    given patterns
-</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>
-    implements the following global options:  -I --include    include names
-    matching the given patterns  -X --exclude    exclude names matching the
-    given patterns
-</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Command_Abstract</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>VersionControl_Hg_Command_Abstract</para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <table>
-     <title>
-      Classes that extend
-      <classname>VersionControl_Hg_Command_Abstract</classname>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Class</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.command.versioncontrol-hg-command-archive-summary">VersionControl_Hg_Command_Archive</link>
-        </entry>
-        <entry>Exports repository to a (optionally compressed) archive file.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.command.versioncontrol-hg-command-status-summary">VersionControl_Hg_Command_Status</link>
-        </entry>
-        <entry>Implements the status command.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.command.versioncontrol-hg-command-version-summary">VersionControl_Hg_Command_Version</link>
-        </entry>
-        <entry>Implements the version command</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.versioncontrol-hg-command-abstract.--construct;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoption;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoptions;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.changeset;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.excluding;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.getcontainer;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.getoptions;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.including;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.parseoutput;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.setcontainer;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.unsetoption;
-&package.versioncontrol.hg.versioncontrol-hg-command-abstract.--call;
- <refentry id="package.versioncontrol.hg.versioncontrol-hg-exception-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Exception</classname>
-   </refname>
-   <refpurpose>Top level exception for this package</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Top level exception for this package</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Exception</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Exception
-       <itemizedlist>
-        <listitem>
-         <para>VersionControl_Hg_Exception</para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <table>
-     <title>
-      Classes that extend
-      <classname>VersionControl_Hg_Exception</classname>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Class</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.exceptions.versioncontrol-hg-command-exception-summary">VersionControl_Hg_Command_Exception</link>
-        </entry>
-        <entry>Exception for Hg commands</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.exceptions.versioncontrol-hg-container-exception-summary">VersionControl_Hg_Container_Exception</link>
-        </entry>
-        <entry>Exception for Hg commands</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Exception</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>Inherited from Exception (Internal Class)</title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>Constructor constructor __construct ( [$message = ], [$code = ] )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getCode (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getFile (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getLine (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getMessage (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getTrace (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getTraceAsString (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>__clone (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>__toString (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- <refentry id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Command_Archive</classname>
-   </refname>
-   <refpurpose>Exports repository to a (optionally compressed) archive file.</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Exports repository to a (optionally compressed) archive file.</title>
-   <para>
-    Usage:
-    <programlisting role="php">
-<![CDATA[ $hg->archive('tip')->to('/home/myself/releases/')->with('tgz')->run();]]>
-    </programlisting>
-   </para>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Command_Archive</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-        <classname>VersionControl_Hg_Command_Abstract</classname>
-       </link>
-       <itemizedlist>
-        <listitem>
-         <para>VersionControl_Hg_Command_Archive</para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Command_Archive</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>
-      Inherited from
-      <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-       <classname>VersionControl_Hg_Command_Abstract</classname>
-      </link>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         Constructor
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--construct">
-          <function>VersionControl_Hg_Command_Abstract::__construct</function>
-         </link>
-        </entry>
-        <entry>Class constructors must be redefined in each Command parent class,  since it must have its dependencies for $container passed in.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoption">
-          <function>VersionControl_Hg_Command_Abstract::addOption</function>
-         </link>
-        </entry>
-        <entry>Add an option</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoptions">
-          <function>VersionControl_Hg_Command_Abstract::addOptions</function>
-         </link>
-        </entry>
-        <entry>Add a set of options all at once</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.changeset">
-          <function>VersionControl_Hg_Command_Abstract::changeset</function>
-         </link>
-        </entry>
-        <entry>Specify which revisions to operate upon in the repository</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.excluding">
-          <function>VersionControl_Hg_Command_Abstract::excluding</function>
-         </link>
-        </entry>
-        <entry>Exclude files and / or directories from consideration.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getcontainer">
-          <function>VersionControl_Hg_Command_Abstract::getContainer</function>
-         </link>
-        </entry>
-        <entry>Returns the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getoptions">
-          <function>VersionControl_Hg_Command_Abstract::getOptions</function>
-         </link>
-        </entry>
-        <entry>Return all the options currently defined for the command</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.including">
-          <function>VersionControl_Hg_Command_Abstract::including</function>
-         </link>
-        </entry>
-        <entry>Include files and / or directories from consideration</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.parseoutput">
-          <function>VersionControl_Hg_Command_Abstract::parseOutput</function>
-         </link>
-        </entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.setcontainer">
-          <function>VersionControl_Hg_Command_Abstract::setContainer</function>
-         </link>
-        </entry>
-        <entry>Sets the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.unsetoption">
-          <function>VersionControl_Hg_Command_Abstract::unsetOption</function>
-         </link>
-        </entry>
-        <entry>Remove an option from the command by its name</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--call">
-          <function>VersionControl_Hg_Command_Abstract::__call</function>
-         </link>
-        </entry>
-        <entry>Executes the actual mercurial command</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.command.versioncontrol-hg-command-archive.--construct;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.execute;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.getarchivetype;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.getdestination;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.getrevision;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.setarchivetype;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.setdestination;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.setrevision;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.to;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-archive.with;
- <refentry id="package.versioncontrol.hg.command.versioncontrol-hg-command-status-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Command_Status</classname>
-   </refname>
-   <refpurpose>Implements the status command.</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Implements the status command.</title>
-   <para>The codes used to show the status of files are:   M = modified   A = added   R = removed   C = clean   ! = missing (deleted by non-hg command, but still tracked)   ? = not tracked   I = ignored</para>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Command_Status</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-        <classname>VersionControl_Hg_Command_Abstract</classname>
-       </link>
-       <itemizedlist>
-        <listitem>
-         <para>VersionControl_Hg_Command_Status</para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Command_Status</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>
-      Inherited from
-      <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-       <classname>VersionControl_Hg_Command_Abstract</classname>
-      </link>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         Constructor
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--construct">
-          <function>VersionControl_Hg_Command_Abstract::__construct</function>
-         </link>
-        </entry>
-        <entry>Class constructors must be redefined in each Command parent class,  since it must have its dependencies for $container passed in.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoption">
-          <function>VersionControl_Hg_Command_Abstract::addOption</function>
-         </link>
-        </entry>
-        <entry>Add an option</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoptions">
-          <function>VersionControl_Hg_Command_Abstract::addOptions</function>
-         </link>
-        </entry>
-        <entry>Add a set of options all at once</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.changeset">
-          <function>VersionControl_Hg_Command_Abstract::changeset</function>
-         </link>
-        </entry>
-        <entry>Specify which revisions to operate upon in the repository</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.excluding">
-          <function>VersionControl_Hg_Command_Abstract::excluding</function>
-         </link>
-        </entry>
-        <entry>Exclude files and / or directories from consideration.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getcontainer">
-          <function>VersionControl_Hg_Command_Abstract::getContainer</function>
-         </link>
-        </entry>
-        <entry>Returns the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getoptions">
-          <function>VersionControl_Hg_Command_Abstract::getOptions</function>
-         </link>
-        </entry>
-        <entry>Return all the options currently defined for the command</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.including">
-          <function>VersionControl_Hg_Command_Abstract::including</function>
-         </link>
-        </entry>
-        <entry>Include files and / or directories from consideration</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.parseoutput">
-          <function>VersionControl_Hg_Command_Abstract::parseOutput</function>
-         </link>
-        </entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.setcontainer">
-          <function>VersionControl_Hg_Command_Abstract::setContainer</function>
-         </link>
-        </entry>
-        <entry>Sets the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.unsetoption">
-          <function>VersionControl_Hg_Command_Abstract::unsetOption</function>
-         </link>
-        </entry>
-        <entry>Remove an option from the command by its name</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--call">
-          <function>VersionControl_Hg_Command_Abstract::__call</function>
-         </link>
-        </entry>
-        <entry>Executes the actual mercurial command</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.command.versioncontrol-hg-command-status.--construct;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-status.all;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-status.execute;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-status.--tostring;
- <refentry id="package.versioncontrol.hg.command.versioncontrol-hg-command-version-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Command_Version</classname>
-   </refname>
-   <refpurpose>Implements the version command</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Implements the version command</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Command_Version</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-        <classname>VersionControl_Hg_Command_Abstract</classname>
-       </link>
-       <itemizedlist>
-        <listitem>
-         <para>VersionControl_Hg_Command_Version</para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Command_Version</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>
-      Inherited from
-      <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract-summary">
-       <classname>VersionControl_Hg_Command_Abstract</classname>
-      </link>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         Constructor
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--construct">
-          <function>VersionControl_Hg_Command_Abstract::__construct</function>
-         </link>
-        </entry>
-        <entry>Class constructors must be redefined in each Command parent class,  since it must have its dependencies for $container passed in.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoption">
-          <function>VersionControl_Hg_Command_Abstract::addOption</function>
-         </link>
-        </entry>
-        <entry>Add an option</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.addoptions">
-          <function>VersionControl_Hg_Command_Abstract::addOptions</function>
-         </link>
-        </entry>
-        <entry>Add a set of options all at once</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.changeset">
-          <function>VersionControl_Hg_Command_Abstract::changeset</function>
-         </link>
-        </entry>
-        <entry>Specify which revisions to operate upon in the repository</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.excluding">
-          <function>VersionControl_Hg_Command_Abstract::excluding</function>
-         </link>
-        </entry>
-        <entry>Exclude files and / or directories from consideration.</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getcontainer">
-          <function>VersionControl_Hg_Command_Abstract::getContainer</function>
-         </link>
-        </entry>
-        <entry>Returns the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.getoptions">
-          <function>VersionControl_Hg_Command_Abstract::getOptions</function>
-         </link>
-        </entry>
-        <entry>Return all the options currently defined for the command</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.including">
-          <function>VersionControl_Hg_Command_Abstract::including</function>
-         </link>
-        </entry>
-        <entry>Include files and / or directories from consideration</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.parseoutput">
-          <function>VersionControl_Hg_Command_Abstract::parseOutput</function>
-         </link>
-        </entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.setcontainer">
-          <function>VersionControl_Hg_Command_Abstract::setContainer</function>
-         </link>
-        </entry>
-        <entry>Sets the container in which  the command operates</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.unsetoption">
-          <function>VersionControl_Hg_Command_Abstract::unsetOption</function>
-         </link>
-        </entry>
-        <entry>Remove an option from the command by its name</entry>
-       </row>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.versioncontrol-hg-command-abstract.--call">
-          <function>VersionControl_Hg_Command_Abstract::__call</function>
-         </link>
-        </entry>
-        <entry>Executes the actual mercurial command</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.command.versioncontrol-hg-command-version.--construct;
-&package.versioncontrol.hg.command.versioncontrol-hg-command-version.execute;
- <refentry id="package.versioncontrol.hg.container.versioncontrol-hg-container-executable-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Container_Executable</classname>
-   </refname>
-   <refpurpose>Provides access to the Hg executable</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Provides access to the Hg executable</title>
-   <para>This is the de-facto parent container of all operations</para>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Container_Executable</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <link linkend="package.default.default.versioncontrol-hg-container-abstract-summary">
-        <classname>VersionControl_Hg_Container_Abstract</classname>
-       </link>
-       <itemizedlist>
-        <listitem>
-         <para>VersionControl_Hg_Container_Executable</para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Container_Executable</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>
-      Inherited from
-      <link linkend="package.default.default.versioncontrol-hg-container-abstract-summary">
-       <classname>VersionControl_Hg_Container_Abstract</classname>
-      </link>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         Constructor
-         <link linkend="package.default.default.versioncontrol-hg-container-abstract.--construct">
-          <function>VersionControl_Hg_Container_Abstract::__construct</function>
-         </link>
-        </entry>
-        <entry>&notdocumented;</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.container.versioncontrol-hg-container-executable.--construct;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.getexecutable;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.getpath;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.getversion;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.setexecutable;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.setpath;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-executable.setversion;
- <refentry id="package.versioncontrol.hg.container.versioncontrol-hg-container-repository-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Container_Repository</classname>
-   </refname>
-   <refpurpose>The Mercurial repository</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>The Mercurial repository</title>
-   <para>
-    Usage:  All calls are proxied from Hg
-    <programlisting role="php">
-<![CDATA[ $hg = new VersionControl_Hg('/path/to/repo');
- $repository = $hg->getRepository();]]>
-    </programlisting>
-   </para>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Container_Repository</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>VersionControl_Hg_Container_Repository</para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </refsect1>
- </refentry>
- &package.versioncontrol.hg.container.versioncontrol-hg-container-repository.--construct;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-repository.create;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-repository.delete;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-repository.getpath;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-repository.isrepository;
-&package.versioncontrol.hg.container.versioncontrol-hg-container-repository.setpath;
- <refentry id="package.versioncontrol.hg.exceptions.versioncontrol-hg-command-exception-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Command_Exception</classname>
-   </refname>
-   <refpurpose>Exception for Hg commands</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Exception for Hg commands</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Command_Exception</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Exception
-       <itemizedlist>
-        <listitem>
-         <para>
-          <link linkend="package.versioncontrol.hg.versioncontrol-hg-exception-summary">
-           <classname>VersionControl_Hg_Exception</classname>
-          </link>
-          <itemizedlist>
-           <listitem>
-            <para>VersionControl_Hg_Command_Exception</para>
-           </listitem>
-          </itemizedlist>
-         </para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </refsect1>
- </refentry>
- <refentry id="package.versioncontrol.hg.exceptions.versioncontrol-hg-container-exception-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Container_Exception</classname>
-   </refname>
-   <refpurpose>Exception for Hg commands</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Exception for Hg commands</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Container_Exception</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Exception
-       <itemizedlist>
-        <listitem>
-         <para>
-          <link linkend="package.versioncontrol.hg.versioncontrol-hg-exception-summary">
-           <classname>VersionControl_Hg_Exception</classname>
-          </link>
-          <itemizedlist>
-           <listitem>
-            <para>VersionControl_Hg_Container_Exception</para>
-           </listitem>
-          </itemizedlist>
-         </para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <table>
-     <title>
-      Classes that extend
-      <classname>VersionControl_Hg_Container_Exception</classname>
-     </title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Class</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>
-         <link linkend="package.versioncontrol.hg.exceptions.versioncontrol-hg-container-repository-exception-summary">VersionControl_Hg_Container_Repository_Exception</link>
-        </entry>
-        <entry>Exception for Hg repositories</entry>
-       </row>
-      </tbody>
-     </tgroup>
-    </table>
-   </para>
-  </refsect1>
- </refentry>
- <refentry id="package.versioncontrol.hg.exceptions.versioncontrol-hg-container-repository-exception-summary">
-  <refnamediv>
-   <refname>
-    Class Summary
-    <classname>VersionControl_Hg_Container_Repository_Exception</classname>
-   </refname>
-   <refpurpose>Exception for Hg repositories</refpurpose>
-  </refnamediv>
-  <refsect1>
-   <title>Exception for Hg repositories</title>
-   <para>PHP version 5</para>
-  </refsect1>
-  <refsect1>
-   <title>
-    Class Trees for
-    <classname>VersionControl_Hg_Container_Repository_Exception</classname>
-   </title>
-   <para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Exception
-       <itemizedlist>
-        <listitem>
-         <para>
-          <link linkend="package.versioncontrol.hg.versioncontrol-hg-exception-summary">
-           <classname>VersionControl_Hg_Exception</classname>
-          </link>
-          <itemizedlist>
-           <listitem>
-            <para>
-             <link linkend="package.versioncontrol.hg.exceptions.versioncontrol-hg-container-exception-summary">
-              <classname>VersionControl_Hg_Container_Exception</classname>
-             </link>
-             <itemizedlist>
-              <listitem>
-               <para>VersionControl_Hg_Container_Repository_Exception</para>
-              </listitem>
-             </itemizedlist>
-            </para>
-           </listitem>
-          </itemizedlist>
-         </para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-   <para>
-    <classname>VersionControl_Hg_Container_Repository_Exception</classname>
-    Inherited Methods
-   </para>
-   <para>
-    <table>
-     <title>Inherited from Exception (Internal Class)</title>
-     <tgroup cols="2">
-      <thead>
-       <row>
-        <entry>Method Name</entry>
-        <entry>Summary</entry>
-       </row>
-      </thead>
-      <tbody>
-       <row>
-        <entry>Constructor constructor __construct ( [$message = ], [$code = ] )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getCode (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getFile (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getLine (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getMessage (  )</entry>
-        <entry>&notdocumented;</entry>
-       </row>
-       <row>
-        <entry>getTrace (  )</entry>
-        <entry>&notdocumented;</entry>