File: exception_rendering_001.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (88 lines) | stat: -rw-r--r-- 2,486 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:exceptionref xml:id="class.exceptionname" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook">
 <title>The ExceptionName Exception</title>
 <titleabbrev>ExceptionName</titleabbrev>

 <partintro>

  <section xml:id="exceptionname.intro">
   Introduction
   <para>
    An ExceptionName exception.
   </para>
  </section>

  <section xml:id="exceptionname.synopsis">
   Class synopsis

   <classsynopsis class="class">
    <ooexception>
     <exceptionname>ExceptionName</exceptionname>
    </ooexception>

    <ooclass>
     <modifier>extends</modifier>
     <classname>Exception</classname>
    </ooclass>

    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>protected</modifier>
     <type>int</type>
     <varname linkend="exceptionname.props.propertyname">propertyName</varname>
     <initializer>"Initial name"</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
     <refentry xml:id="exceptionname.construct" xmlns="http://docbook.org/ns/docbook">
      <refnamediv>
       <refname>ExceptionName::__construct</refname>
       <refpurpose>Constructs the exception</refpurpose>
      </refnamediv>

      <refsect1 role="description">
       Description
       <constructorsynopsis role="ExceptionName">
        <modifier>public</modifier> <methodname>ExceptionName::__construct</methodname>
        <methodparam choice="opt"><type>string</type><parameter>propertyName</parameter><initializer>""</initializer></methodparam>
       </constructorsynopsis>
       <para>
        Constructs the Exception.
       </para>
      </refsect1>

      <refsect1 role="parameters">
       Parameters
       <para>
       <variablelist>
        <varlistentry>
         <term><parameter>parameterName</parameter></term>
         <listitem>
          <para>
           Description of the parameter
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </refsect1>
    </refentry>
   </classsynopsis>

  </section>

  <section xml:id="exceptionname.props">
   Properties
   <variablelist>
    <varlistentry xml:id="exceptionname.props.propertyname">
     <term><varname>propertyName</varname></term>
     <listitem>
      <para>Description of the property</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

 </partintro>

</phpdoc:exceptionref>