lemon.external.epydoc.objdoc.Var

Package lemon :: Package external :: Package epydoc :: Module objdoc :: Class Var

[show private | hide private]

Class Var

The documentation for a variable. This documentation consists of the following fields:

uid: The variable's UID
descr: A description of the variable
type: A description of the variable's type
has_value: A flag indicating whether a variable has a value. If this flag is true, then the value can be accessed via the Var's UID.

Vars are used by ModuleDoc to document variables; and by ClassDoc to document instance and class variables.

Method Summary
	`__init__(self, name, uid, descr, type, has_value, autogenerated)` Construct the documentation for a variable.
	`__repr__(self)`
`boolean`	`autogenerated(self)` Return true if this variable documentation was generated automatically from a module variable (i.e., not from a `@var` field or a `@type` field).
`markup.ParsedDocstring`	`descr(self)` Return a description of this variable.
`boolean`	`has_value(self)` Return true if the variable documented by this `Var` has a value.
	`is_private(self)` Return true if this variable is a private object.
	`is_public(self)` Return true if this variable is a public object.
`string`	`name(self)` Return the short name of this variable.
`UID`	`target(self)` Return the UID of the variable documented by this `Var`.
`markup.ParsedDocstring`	`type(self)` Return a description of this variable's type
`UID`	`uid(self)` Return the UID of the variable documented by this `Var`.

Method Details

Construct the documentation for a variable.

Parameters:: uid - A unique identifier for the variable.
(type=string); descr - A description of the variable.
(type=markup.ParsedDocstring); type - A description of the variable's type.
(type=markup.ParsedDocstring); has_value - Whether the documented variable has a value.
(type=boolean); autogenerated - Whether the variable was automatically detected (and not explicitly documented).
(type=boolean)

Returns:: True if this variable documentation was generated automatically from a module variable (i.e., not from a @var field or a @type field).
(type=boolean)

Returns:: True if the variable documented by this Var has a value. If this function returns true, then the value can be accessed via the Var's UID.
(type=boolean)

Returns:: True if this variable is a private object. This is equivalant to self.uid().is_private()

Returns:: True if this variable is a public object. This is equivalant to self.uid().is_public()

Returns:: A description of this variable's type
(type=markup.ParsedDocstring)

Generated by Epydoc 2.0 on Mon Nov 10 15:08:08 2003