Changeset 1051

Show
Ignore:
Timestamp:
10/28/06 10:09:05 (2 years ago)
Author:
wrobell
Message:

- documentation cleanup

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • gaphor/branches/new-canvas/gaphor/diagram/__init__.py

    r1050 r1051  
    3737    """ 
    3838    Item style information. Style information is provided through object's 
    39     attributes, i.e. 
     39    attributes, i.e.:: 
    4040 
    41         __style__ = { 
    42             'name-align': ('center', 'top'), 
    43         } 
     41        class InitialNodeItem 
     42            __style__ = { 
     43                'name-align': ('center', 'top'), 
     44            } 
    4445 
    45     is translated to 
     46    is translated to:: 
    4647 
    4748        >>> print style.name_align 
    …… 
    5556        underscode, i.e. 'name-align' -> 'name_align'. 
    5657 
    57         name  - style variable name 
    58         value - style variable value 
     58        @param name: style variable name 
     59        @param value: style variable value 
    5960        """ 
    6061        name = name.replace('-', '_') 
    …… 
    7172 
    7273class DiagramItemMeta(type): 
    73     """Initialize a new diagram item. 
     74    """ 
     75    Initialize a new diagram item. 
    7476    1. Register UML.Elements by means of the __uml__ attribute (see 
    7577       mapUMLClass method). 
    76     1. Set items styles information. 
     78    2. Set items styles information. 
    7779 
    78     styles - style information 
     80    @ivar styles: style information 
    7981    """ 
    8082 
    …… 
    9092        Map UML class to diagram item. 
    9193 
    92         cls  - new instance of item class 
    93         data - metaclass data with UML class information  
     94        @param cls: new instance of item class 
     95        @param data: metaclass data with UML class information  
    9496 
    9597        """ 
    …… 
    108110        style information from base classes. 
    109111 
    110         cls   - new instance of diagram item class 
    111         bases - base classes of an item 
    112         data  - metaclass data with styles information 
     112        @param cls:  new instance of diagram item class 
     113        @param bases: base classes of an item 
     114        @param data: metaclass data with styles information 
    113115        """ 
    114116        styles = Styles() 

  • gaphor/branches/new-canvas/gaphor/diagram/diagramitem.py

    r1049 r1051  
    2929            disconnect = DiagramItem.disconnect 
    3030            ... 
     31 
     32    @cvar style: styles information (derived from DiagramItemMeta) 
    3133    """ 
    3234