createcomment.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domdocument.createcomment" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>DOMDocument::createComment</refname>
  <refpurpose>Create new comment node</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMDocument">
   <modifier>public</modifier> <type>DOMComment</type><methodname>DOMDocument::createComment</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function creates a new instance of class
   <classname>DOMComment</classname>. &dom.node.inserted;
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       The content of the comment.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The new <classname>DOMComment</classname>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       In case of an error, a <classname>DomException</classname> is thrown now.
       Previously, &false; was returned.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMNode::appendChild</methodname></member>
    <member><methodname>DOMDocument::createAttribute</methodname></member>
    <member><methodname>DOMDocument::createAttributeNS</methodname></member>
    <member><methodname>DOMDocument::createCDATASection</methodname></member>
    <member><methodname>DOMDocument::createDocumentFragment</methodname></member>
    <member><methodname>DOMDocument::createElement</methodname></member>
    <member><methodname>DOMDocument::createElementNS</methodname></member>
    <member><methodname>DOMDocument::createEntityReference</methodname></member>
    <member><methodname>DOMDocument::createProcessingInstruction</methodname></member>
    <member><methodname>DOMDocument::createTextNode</methodname></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->