Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

MSERGEANT / AxKit-Needs / libs / libxslt-1.0.14 / tests / docbook / test / classsynop.xml 

            

              
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

              
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
                  "../dtd/4.0/docbookx.dtd">
<chapter><title>Class Synopses</title>
<para>This example is Perl; it's the standard DirHandle module. I've
cut out the code, so you'll have to trust me on the parameters.
</para>
<para>ProgramListing version:</para>
<programlisting>
package DirHandle;
require 5.000;
use Carp;
use Symbol;
sub new {
}
</programlisting>
<para>ClassSynopsis version:</para>
<classsynopsis language="perl">
  <ooclass><classname>DirHandle</classname></ooclass>
  <ooclass><classname>superclass1</classname></ooclass>
  <ooclass><classname>superclass2</classname></ooclass>
  <classsynopsisinfo>
require 5.000;
use Carp;
use Symbol;
</classsynopsisinfo>
  <constructorsynopsis>
    <methodname>new</methodname>
    <methodparam choice="opt"><parameter>$dirname</parameter></methodparam>
  </constructorsynopsis>
  <destructorsynopsis>
    <methodname>DESTROY</methodname>
  </destructorsynopsis>
</classsynopsis>
<para>This example is IDL from the DOM spec.</para>
<para>ProgramListing version:</para>
<programlisting>
interface Element : Node {
  readonly attribute  DOMString            tagName;
  DOMString                 getAttribute(in DOMString name);
  void                      setAttribute(in DOMString name, 
                                         in DOMString value)
                                         raises(DOMException);
};
</programlisting>
<para>ClassSynopsis version:</para>
<classsynopsis class="interface" language="idl">
  <ooclass><classname>Element</classname></ooclass>
  <ooclass><classname>Node</classname></ooclass>
  <fieldsynopsis>
    <modifier>readonly</modifier>
    <modifier>attribute</modifier>
    <type>DOMString</type>
    <varname>tagName</varname>
  </fieldsynopsis>
  <methodsynopsis>
    <type>DOMString</type>
    <methodname>getAttribute</methodname>
      <methodparam>
        <modifier>in</modifier>
        <type>DOMString</type>
        <parameter>name</parameter>
      </methodparam>
  </methodsynopsis>
  <methodsynopsis>
    <void/>
    <methodname>setAttribute</methodname>
      <methodparam>
        <modifier>in</modifier>
        <type>DOMString</type>
        <parameter>name</parameter>
      </methodparam>
      <methodparam>
        <modifier>in</modifier>
        <type>DOMString</type>
        <parameter>value</parameter>
      </methodparam>
    <exceptionname>DOMException</exceptionname>
  </methodsynopsis>
</classsynopsis>
<classsynopsis language="java">
  <ooclass><modifier>public</modifier>
           <classname>TextFileWriter</classname>
  </ooclass>
  <ooclass><classname>Superclass1</classname></ooclass>
  <ooclass><classname>Superclass2</classname></ooclass>
  <oointerface><interfacename>Interface1</interfacename></oointerface>
  <oointerface><interfacename>Interface2</interfacename></oointerface>
  <ooexception><exceptionname>Exception1</exceptionname></ooexception>
  <ooexception><exceptionname>Exception2</exceptionname></ooexception>
  <fieldsynopsis>
    <modifier>private</modifier>
    <type>Writer</type>
    <varname>writer</varname>
  </fieldsynopsis>
  <fieldsynopsis>
    <modifier>public</modifier>
    <type>String</type>
    <varname>writerName</varname>
    <initializer>"MyWriter"</initializer>
  </fieldsynopsis>
  <methodsynopsis>
    <modifier>static</modifier>
    <modifier>public</modifier>
    <void/>
    <methodname>write</methodname>
    <methodparam>
       <type>ResultTreeFragment</type>
       <parameter>frag</parameter>
    </methodparam>
    <methodparam>
       <type>String</type>
       <parameter>file</parameter>
    </methodparam>
    <exceptionname>Exception1</exceptionname>
    <exceptionname>Exception2</exceptionname>
  </methodsynopsis>
</classsynopsis>
<programlisting>
class Rectangle_with_data:  virtual Shape, virtual Data_container
{
...
};
</programlisting>
<para>ClassSynopsis version:</para>
<classsynopsis language="cpp">
  <ooclass><classname>Rectangle_with_data</classname></ooclass>
  <ooclass><modifier>virtual</modifier><classname>Shape</classname>
     </ooclass>
  <ooclass><modifier>virtual</modifier><classname>Data_container</classname>
     </ooclass>
  <classsynopsisinfo>...</classsynopsisinfo>
</classsynopsis>
</chapter>