epydoc.objdoc.Var

Package epydoc :: Module objdoc :: Class Var |
[show private | hide private]
[frames | no frames]

## 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.

`Var`s 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

### __init__(self, name, uid, descr=None, type=None, has_value=1, autogenerated=0) (Constructor) 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`)

### autogenerated(self) 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`)

### descr(self) Returns: A description of this variable. (type=`markup.ParsedDocstring`)

### has_value(self) 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`)

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

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

### name(self) Returns: The short name of this variable. (type=`string`)

### target(self) Returns: The UID of the variable documented by this `Var`. (type=`UID`)

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

### uid(self) Returns: The UID of the variable documented by this `Var`. (type=`UID`)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:11 2004 | http://epydoc.sf.net