Chapter 1. Class Synopses
Chapter 1. Class Synopses
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.
ProgramListing version:
package DirHandle;
require 5.000;
use Carp;
use Symbol;
sub new {
}
ClassSynopsis version:
<classsynopsis><ooclass>DirHandle</ooclass><ooclass>superclass1</ooclass><ooclass>superclass2</ooclass><classsynopsisinfo>
require 5.000;
use Carp;
use Symbol;
</classsynopsisinfo><constructorsynopsis>new<methodparam>$dirname</methodparam></constructorsynopsis><destructorsynopsis>DESTROY</destructorsynopsis></classsynopsis>
This example is IDL from the DOM spec.
ProgramListing version:
interface Element : Node {
readonly attribute DOMString tagName;
DOMString getAttribute(in DOMString name);
void setAttribute(in DOMString name,
in DOMString value)
raises(DOMException);
};
ClassSynopsis version:
<classsynopsis><ooclass>Element</ooclass><ooclass>Node</ooclass><fieldsynopsis><modifier>readonly</modifier><modifier>attribute</modifier>DOMStringtagName</fieldsynopsis><methodsynopsis>DOMStringgetAttribute<methodparam><modifier>in</modifier>DOMStringname</methodparam></methodsynopsis><methodsynopsis>();setAttribute<methodparam><modifier>in</modifier>DOMStringname</methodparam><methodparam><modifier>in</modifier>DOMStringvalue</methodparam>DOMException</methodsynopsis></classsynopsis>
<classsynopsis><ooclass><modifier>public</modifier>TextFileWriter</ooclass><ooclass>Superclass1</ooclass><ooclass>Superclass2</ooclass><oointerface>Interface1</oointerface><oointerface>Interface2</oointerface><ooexception>Exception1</ooexception><ooexception>Exception2</ooexception><fieldsynopsis><modifier>private</modifier>Writerwriter</fieldsynopsis><fieldsynopsis><modifier>public</modifier>StringwriterName<initializer>"MyWriter"</initializer></fieldsynopsis><methodsynopsis><modifier>static</modifier><modifier>public</modifier>();write<methodparam>ResultTreeFragmentfrag</methodparam><methodparam>Stringfile</methodparam>Exception1Exception2</methodsynopsis></classsynopsis>
class Rectangle_with_data: virtual Shape, virtual Data_container
{
...
};
ClassSynopsis version:
<classsynopsis><ooclass>Rectangle_with_data</ooclass><ooclass><modifier>virtual</modifier>Shape</ooclass><ooclass><modifier>virtual</modifier>Data_container</ooclass><classsynopsisinfo>...</classsynopsisinfo></classsynopsis>