File 'lib/ns.cls' (part of 'AutoDOC')

Description (short): Namespaces
Written by: Andreas Kupries
Description: Management of namespaces.
Keywords: namespaces

Class 'namespaceDescription'

Description

This class manages the properties of a single class.

Superclasses

azIndexEntry

Options

log

Methods

public: WriteList (title mList)
addClass (o)
addNamespace (o)
addProcedure (o)
clear ()
firstLetter ()
getPage ()
namespaceDescription ()
write ()

Membervariables

public: listtype
classes
namespaces
procs
parent

Options

-log: Handle of the syslogConnection object to use for logging

WriteList (title mList)

Internal method used by the page generator routine (write) to produce the output for all procedures contained in the namespace.

Argument: title The term under which the list is written.

Argument: mList The list of objects to call.

addClass (o)

Add a class defined in this namespace to it.

Argument: o The classDescription object added to the namespace.

addNamespace (o)

Add a namespace defined in this namespace to it.

Argument: o The namespaceDescription object added to the namespace.

addProcedure (o)

Add a procedure defined in this namespace to it.

Argument: o The procDescription object added to the namespace.

clear ()

Resets state information.

firstLetter ()

Overrides azIndexEntry:firstLetter

Returns: the first letter of the name of this index entry.

getPage ()

Returns: The url of the page containing the namespace description.

namespaceDescription ()

Constructor. Takes the name of the namespace, extracts the name of the containing namespace and retrieves the associated object. If that does not exist it is constructed and added to the global index.

write ()

Generates the formatted text describing the namespace.

Membervariables

listtype: Either one of comma or par. Defines the appearance of the lists used to reference containing namespace, procedures and classes. Takes its value from distribution:clisttype.
classes: List of classes contained in the namespace. Actually contains the handles of their classDescription objects and not their names.
namespaces: List of namespaces contained in the namespace. Actually contains the handles of their classDescription objects and not their names.
procs: List of procedures contained in the namespace. Actually contains the handles of their procDescription objects and not their names.
parent: Handle of the parent namespace.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

WriteList (title mList)
Internal method used by the page generator routine (write) to produce the output for all procedures contained in the namespace.
Argument: title	The term under which the list is written.
Argument: mList	The list of objects to call.

addClass (o)
Add a class defined in this namespace to it.
Argument: o	The classDescription object added to the namespace.

addNamespace (o)
Add a namespace defined in this namespace to it.
Argument: o	The namespaceDescription object added to the namespace.

addProcedure (o)
Add a procedure defined in this namespace to it.
Argument: o	The procDescription object added to the namespace.

firstLetter ()
Overrides azIndexEntry:firstLetter
Returns: the first letter of the name of this index entry.

getPage ()
Returns: The url of the page containing the namespace description.

namespaceDescription ()
Constructor. Takes the name of the namespace, extracts the name of the containing namespace and retrieves the associated object. If that does not exist it is constructed and added to the global index.

write ()
Generates the formatted text describing the namespace.