classname.xml

<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.classname" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The ClassName class</title>
 <titleabbrev>ClassName</titleabbrev>
 
 <partintro>

  <!-- {{{ ClassName intro -->
  <section xml:id="classname.intro">
   &reftitle.intro;
   <simpara>
    Description of the class.
   </simpara>
  </section>
  <!-- }}} -->

  <section xml:id="classname.synopsis">
   &reftitle.classsynopsis;

   <!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>ClassName</classname>
    </ooclass>

    <!-- If the class extends another one, use this -->
    <ooclass>
     <modifier>extends</modifier>
     <classname>ParentClass</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Interface1</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>Interface2</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>Interface3</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="classname.constants.some-constant">ClassName::SOME_CONSTANT</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>string</type>
     <varname linkend="classname.props.someproperty">SomeProperty</varname>
     <initializer>""</initializer>
    </fieldsynopsis>

    <!-- Edit the parentclass below -->
    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parentclass')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))"/>

    <!-- Edit the classname below and ClassName in the @role='ClassName' XPath query -->
    <!-- If has a constructor -->
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='ClassName'])"/>
    <!-- If has a destructor -->
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[@role='ClassName'])"/>
    <!-- If has methods -->
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ClassName'])"/>

    <!-- Edit the parentclass below -->
    <!--
        If the class extends a class use this.
        Repeat the <xi:include> tag for all the parent classes in the event of multiple extensions;
        i.e. class XYZ extends class XY and class XY extends class X
    -->
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parentclass')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ParentClass'])"/>
   </classsynopsis>
   <!-- }}} -->

  </section>

  <section xml:id="classname.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="classname.constants.some-constant">
     <term><constant>ClassName::SOME_CONSTANT</constant></term>
     <listitem>
      <simpara>
       Some description for the constant.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

  <!-- If properties are documented "as a method/procedural function", use this
      <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis)" />
  -->
  <section xml:id="error.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="error.props.someproperty">
     <term><varname>someProperty</varname></term>
     <listitem>
      <simpara>
       Description
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
 
 </partintro>
 
 &reference.extname.entities.classname;
 
</reference>
<!-- 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
-->