Source

VersionControl_Hg / src / Documentation / API / Docbook / versioncontrol / hg / command / versioncontrol-hg-command-tag / execute.xml

The default branch has multiple heads

Full commit
<refentry id="package.versioncontrol.hg.command.versioncontrol-hg-command-tag.execute">
 <refnamediv>
  <refname>
   <function>VersionControl_Hg_Command_Tag::execute</function>
  </refname>
  <refpurpose>Execute the command and return the results.</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>require_once &apos;/Hg/Command/Tag.php&apos;;</funcsynopsisinfo>
   <funcprototype>
    <funcdef>
     string
     <function>VersionControl_Hg_Command_Tag::execute</function>
    </funcdef>
    <paramdef>
     <parameter>
      <optional>$params = &null;</optional>
     </parameter>
    </paramdef>
    <paramdef>
     <link linkend="package.versioncontrol.hg.versioncontrol-hg-summary">VersionControl_Hg</link>
     <parameter>
      <optional>$hg = &null;</optional>
     </parameter>
    </paramdef>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-tag.execute.desc">
  &title.desc;
  &notdocumented;
</refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-tag.execute.param">
  &title.param;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <type />
      <parameter>$params</parameter>
     </term>
     <listitem>
      <para>The options passed to the Log command</para>
     </listitem>
    </varlistentry>
   </variablelist>
   <variablelist>
    <varlistentry>
     <term>
      <type>
       <link linkend="package.versioncontrol.hg.versioncontrol-hg-summary">VersionControl_Hg</link>
      </type>
      <parameter>$hg</parameter>
     </term>
     <listitem>
      <para />
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-tag.execute.throws">
  &title.throws;
  <para>
   <emphasis>throws</emphasis>
   no exceptions thrown
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-tag.execute.note">
  &title.note;
  &note.notstatic;
</refsect1>
</refentry>