[pygccxml-commit] SF.net SVN: pygccxml:[1651] pygccxml_dev/pygccxml/declarations

[<rom...@us...>]

Revision: 1651
          http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1651&view=rev
Author:   roman_yakovenko
Date:     2009-02-02 19:04:21 +0000 (Mon, 02 Feb 2009)

Log Message:
-----------
sphinx - correct documentation string

Modified Paths:
--------------
    pygccxml_dev/pygccxml/declarations/__init__.py
    pygccxml_dev/pygccxml/declarations/algorithm.py
    pygccxml_dev/pygccxml/declarations/calldef.py
    pygccxml_dev/pygccxml/declarations/class_declaration.py
    pygccxml_dev/pygccxml/declarations/cpptypes.py
    pygccxml_dev/pygccxml/declarations/matchers.py
    pygccxml_dev/pygccxml/declarations/namespace.py
    pygccxml_dev/pygccxml/declarations/type_traits.py
    pygccxml_dev/pygccxml/declarations/typedef.py
    pygccxml_dev/pygccxml/declarations/variable.py

Modified: pygccxml_dev/pygccxml/declarations/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/__init__.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/__init__.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -233,29 +233,29 @@
 
 #make matchers to look more like functors
 or_matcher = or_matcher_t
-"""see L{or_matcher} for documentation"""
+"""see :class:or_matcher for documentation"""
 and_matcher = and_matcher_t
-"""see L{and_matcher} for documentation"""
+"""see :class:and_matcher for documentation"""
 not_matcher = not_matcher_t
-"""see L{not_matcher} for documentation"""
+"""see :class:not_matcher for documentation"""
 declaration_matcher = declaration_matcher_t
-"""see L{declaration_matcher} for documentation"""
+"""see :class:declaration_matcher for documentation"""
 calldef_matcher = calldef_matcher_t
-"""see L{calldef_matcher} for documentation"""
+"""see :class:calldef_matcher for documentation"""
 namespace_matcher = namespace_matcher_t
-"""see L{namespace_matcher} for documentation"""
+"""see :class:namespace_matcher for documentation"""
 variable_matcher = variable_matcher_t
-"""see L{variable_matcher} for documentation"""
+"""see :class:variable_matcher for documentation"""
 regex_matcher = regex_matcher_t
-"""see L{regex_matcher} for documentation"""
+"""see :class:regex_matcher for documentation"""
 access_type_matcher = access_type_matcher_t
-"""see L{access_type_matcher} for documentation"""
+"""see :class:access_type_matcher for documentation"""
 operator_matcher = operator_matcher_t
-"""see L{operator_matcher} for documentation"""
+"""see :class:operator_matcher for documentation"""
 custom_matcher = custom_matcher_t
-"""see L{custom_matcher} for documentation"""
+"""see :class:custom_matcher for documentation"""
 virtuality_type_matcher = virtuality_type_matcher_t
-"""see L{virtuality_type_matcher} for documentation"""
+"""see :class:virtuality_type_matcher for documentation"""
 
 from matcher import matcher
 

Modified: pygccxml_dev/pygccxml/declarations/algorithm.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/algorithm.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/algorithm.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -12,7 +12,7 @@
     returns a list of parent declarations names
 
     :param decl: declaration for which declaration path should be calculated
-    :type decl: L{declaration_t}
+    :type decl: :class:declaration_t
 
     :rtype: [names], where first item contains top parent name and last item
              contains decl name
@@ -42,7 +42,7 @@
     have default value
 
     :param decl: declaration for which declaration path should be calculated
-    :type decl: L{declaration_t}
+    :type decl: :class:declaration_t
 
     :rtype: [names], where first item contains top parent name and last item
              contains decl name
@@ -75,9 +75,9 @@
     returns a reference to a named parent declaration
 
     :param decl: the child declaration
-    :type decl: L{declaration_t}
+    :type decl: :class:declaration_t
 
-    :rtype: reference to L{declaration_t} or None if not found
+    :rtype: reference to :class:declaration_t or None if not found
     """
     if not decl:
         return None
@@ -97,12 +97,11 @@
 
 def full_name( decl, with_defaults=True ):
     """
-    returns full name of the declaration
-    :param decl: declaration for which full name should be calculated. If decl
-    belongs to unnamed namespace, then L{full_name} is not valid C++ full name.
-
-    :type decl: L{declaration_t}
-
+    returns declaration full qualified name
+    
+    If `decl` belongs to anonymious namespace or class, the function will return C++ illegal qualified name.
+    :param decl: :class:declaration_t
+    :type decl: :class:declaration_t
     :rtype: full name of declarations.
     """
     if None is decl:
@@ -122,7 +121,7 @@
     converts tree representation of declarations to flatten one.
 
     :param decl_or_decls: reference to list of declaration's or single declaration
-    :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
+    :type decl_or_decls: :class:declaration_t or [ :class:declaration_t ]
 
     :rtype: [ all internal declarations ]
     """
@@ -153,7 +152,7 @@
     converts tree representation of declarations to flatten one.
 
     :param decl_or_decls: reference to list of declaration's or single declaration
-    :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
+    :type decl_or_decls: :class:declaration_t or [ :class:declaration_t ]
 
     :rtype: [ all internal declarations ]
     """
@@ -192,7 +191,7 @@
     helper class for different search algorithms.
 
     This class will help developer to match declaration by:
-        - declaration type, for example L{class_t} or L{operator_t}.
+        - declaration type, for example :class:class_t or L{operator_t}.
         - declaration name
         - declaration full name
         - reference to parent declaration
@@ -209,7 +208,7 @@
         returns True if inst do match one of specified criteria
 
         :param inst: declaration instance
-        :type inst: L{declaration_t}
+        :type inst: :class:declaration_t
 
         :rtype: bool
         """
@@ -240,7 +239,7 @@
     """
     returns a list of all declarations that match criteria, defined by developer
 
-    For more information about arguments see L{match_declaration_t} class.
+    For more information about arguments see :class:match_declaration_t class.
 
     :rtype: [ matched declarations ]
     """
@@ -262,9 +261,9 @@
     returns single declaration that match criteria, defined by developer.
     If more the one declaration was found None will be returned.
 
-    For more information about arguments see L{match_declaration_t} class.
+    For more information about arguments see :class:match_declaration_t class.
 
-    :rtype: matched declaration L{declaration_t} or None
+    :rtype: matched declaration :class:declaration_t or None
     """
     decl = find_all_declarations( declarations, type=type, name=name, parent=parent, recursive=recursive, fullname=fullname )
     if len( decl ) == 1:
@@ -274,9 +273,9 @@
     """
     returns first declaration that match criteria, defined by developer
 
-    For more information about arguments see L{match_declaration_t} class.
+    For more information about arguments see :class:match_declaration_t class.
 
-    :rtype: matched declaration L{declaration_t} or None
+    :rtype: matched declaration :class:declaration_t or None
     """
     matcher = match_declaration_t(type, name, fullname, parent)
     if recursive:
@@ -296,7 +295,7 @@
     contains all file names of declarations.
 
     :param decl_or_decls: reference to list of declaration's or single declaration
-    :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
+    :type decl_or_decls: :class:declaration_t or [ :class:declaration_t ]
 
     :rtype: set( declaration file names )
     """

Modified: pygccxml_dev/pygccxml/declarations/calldef.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/calldef.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/calldef.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -140,7 +140,7 @@
         self._type = type
     type = property( _get_type, _set_type
                      , doc="""The type of the argument.
-                     @type: L{type_t}""")
+                     @type: :class:type_t""")
 
     def _get_attributes( self ):
         return self._attributes
@@ -198,7 +198,7 @@
         self._arguments = arguments
     arguments = property( _get_arguments , _set_arguments
                           , doc="""The argument list.
-                          @type: list of L{argument_t}""")
+                          @type: list of :class:argument_t""")
 
     @property
     def has_ellipsis( self ):
@@ -241,7 +241,7 @@
         self._exceptions = exceptions
     exceptions = property( _get_exceptions, _set_exceptions
                            , doc="""The list of exceptions.
-                           @type: list of L{declaration_t}""")
+                           @type: list of :class:declaration_t""")
 
     def _get_return_type(self):
         return self._return_type
@@ -249,7 +249,7 @@
         self._return_type = return_type
     return_type = property( _get_return_type, _set_return_type
                             , doc='''The type of the return value of the "callable" or None (constructors).
-                            @type: L{type_t}
+                            @type: :class:type_t
                             ''')
     @property
     def overloads(self):
@@ -423,7 +423,7 @@
     def _get_access_type(self):
         return self.parent.find_out_member_access_type( self )
     access_type = property( _get_access_type
-                            , doc="""Return the access type of the member (as defined by the string constants in the class L{ACCESS_TYPES}.
+                            , doc="""Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES.
                             @type: str""")
 
     def _get_has_const(self):
@@ -441,7 +441,7 @@
                            , doc="""describes, whether "callable" has static modifier or not""")
 
     def function_type(self):
-        """returns function type. See L{type_t} hierarchy"""
+        """returns function type. See :class:type_t hierarchy"""
         if self.has_static:
             return cpptypes.free_function_type_t( return_type=self.return_type
                                            , arguments_types=[ arg.type for arg in self.arguments ] )
@@ -495,7 +495,7 @@
         return []
 
     def function_type(self):
-        """returns function type. See L{type_t} hierarchy"""
+        """returns function type. See :class:type_t hierarchy"""
         return cpptypes.free_function_type_t( return_type=self.return_type
                                      , arguments_types=[ arg.type for arg in self.arguments ] )
 

Modified: pygccxml_dev/pygccxml/declarations/class_declaration.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/class_declaration.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/class_declaration.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -313,21 +313,21 @@
     def _set_public_members( self, new_public_members ):
         self._public_members = new_public_members
     public_members = property( _get_public_members, _set_public_members
-                               , doc="list of all public L{members<declaration_t>}")
+                               , doc="list of all public :class:`members <declarationt_>`")
 
     def _get_private_members(self):
         return self._private_members
     def _set_private_members( self, new_private_members ):
         self._private_members = new_private_members
     private_members = property( _get_private_members, _set_private_members
-                                , doc="list of all private L{members<declaration_t>}")
+                                , doc="list of all private :class:`members <declarationt_>`")
 
     def _get_protected_members(self):
         return self._protected_members
     def _set_protected_members( self, new_protected_members ):
         self._protected_members = new_protected_members
     protected_members = property( _get_protected_members, _set_protected_members
-                                  , doc="list of all protected L{members<declaration_t>}" )
+                                  , doc="list of all protected :class:`members <declarationt_>`" )
 
     def _get_aliases(self):
         return self._aliases
@@ -364,7 +364,7 @@
         data will stop work and may to give you wrong results.
 
         :param access: describes desired members
-        :type access: L{ACCESS_TYPES}
+        :type access: :class:ACCESS_TYPES
 
         :rtype: [ members ]
         """
@@ -387,7 +387,7 @@
         :param decl: reference to a L{declaration<declaration_t>}
 
         :param access: member access type
-        :type access: L{ACCESS_TYPES}
+        :type access: :class:ACCESS_TYPES
         """
         if access == ACCESS_TYPES.PUBLIC:
             self.public_members.append( decl )
@@ -406,7 +406,7 @@
         removes decl from  members list
 
         :param decl: declaration to be removed
-        :type decl: L{declaration_t}
+        :type decl: :class:declaration_t
         """
         container = None
         access_type = self.find_out_member_access_type( decl )
@@ -424,9 +424,9 @@
         returns member access type
 
         :param member: member of the class
-        :type member: L{declaration_t}
+        :type member: :class:declaration_t
 
-        :rtype: L{ACCESS_TYPES}
+        :rtype: :class:ACCESS_TYPES
         """
         assert member.parent is self
         if not member.cache.access_type:

Modified: pygccxml_dev/pygccxml/declarations/cpptypes.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/cpptypes.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/cpptypes.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -80,7 +80,7 @@
 
 
 class dummy_type_t( type_t ):
-    """provides L{type_t} interface for a string, that defines C++ type.
+    """provides :class:type_t interface for a string, that defines C++ type.
 
     This class could be very useful in the code generator.
     """
@@ -495,9 +495,9 @@
         returns free function type
 
         :param return_type: function return type
-        :type return_type: L{type_t}
+        :type return_type: :class:type_t
 
-        :param arguments_types: list of argument L{type<type_t>}
+        :param arguments_types: list of argument :class:`type <type_t>`
 
         :rtype: L{free_function_type_t}
         """
@@ -629,7 +629,7 @@
     def _set_variable_type(self, new_type):
         self._mv_type = new_type
     variable_type = property( _get_variable_type, _set_variable_type
-                              , doc="describes member variable L{type<type_t>}")
+                              , doc="describes member variable :class:`type <type_t>`")
 
     def build_decl_string(self, with_defaults=True):
         return self.NAME_TEMPLATE % { 'type' : self.variable_type.build_decl_string(with_defaults)
@@ -644,7 +644,7 @@
 ## declarated types:
 
 class declarated_t( type_t ):
-    """class that binds between to hierarchies: L{type_t} and L{declaration_t}"""
+    """class that binds between to hierarchies: :class:type_t and :class:declaration_t"""
     def __init__( self, declaration ):
         type_t.__init__( self )
         self._declaration = declaration

Modified: pygccxml_dev/pygccxml/declarations/matchers.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/matchers.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/matchers.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -112,12 +112,12 @@
           - declaration name, also could be fully qualified name
             Example: wstring or ::std::wstring
           - declaration type
-            Example: L{class_t}, L{namespace_t}, L{enumeration_t}
+            Example: :class:class_t, :class:namespace_t, :class:enumeration_t
           - location within file system ( file or directory )
     """
     def __init__( self, name=None, decl_type=None, header_dir=None, header_file=None ):
         """
-        :param decl_type: declaration type to match by. For example L{enumeration_t}.
+        :param decl_type: declaration type to match by. For example :class:enumeration_t.
         :type decl_type: any class that derives from L{declarations.declaration_t} class
 
         :param name: declaration name, could be full name.
@@ -259,13 +259,13 @@
 class variable_matcher_t( declaration_matcher_t ):
     """
     Instance of this class will match variables by next criteria:
-        - L{declaration_matcher_t} criteria
+        - :class:declaration_matcher_t criteria
         - variable type. Example: L{int_t} or 'int'
     """
     def __init__( self, name=None, type=None, header_dir=None, header_file=None ):
         """
         :param type: variable type
-        :type type: string or instance of L{type_t} derived class
+        :type type: string or instance of :class:type_t derived class
         """
         declaration_matcher_t.__init__( self
                                         , name=name
@@ -315,7 +315,7 @@
 class calldef_matcher_t( declaration_matcher_t ):
     """
     Instance of this class will match callable by next criteria:
-        - L{declaration_matcher_t} criteria
+        - :class:declaration_matcher_t criteria
         - return type. Example: L{int_t} or 'int'
         - argument types
     """
@@ -323,10 +323,10 @@
     def __init__( self, name=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None):
         """
         :param return_type: callable return type
-        :type return_type: string or instance of L{type_t} derived class
+        :type return_type: string or instance of :class:type_t derived class
 
         :param arg_types: list of function argument types. arg_types can contain.
-        Any item within the list could be string or instance of L{type_t} derived
+        Any item within the list could be string or instance of :class:type_t derived
         class. If you don't want some argument to participate in match you can
         put None. For example:
 
@@ -475,7 +475,7 @@
     def __init__( self, access_type ):
         """
         :param access_type: declaration access type
-        :type access_type: L{ACCESS_TYPES} defines few consts for your convinience.
+        :type access_type: :class:ACCESS_TYPES defines few consts for your convinience.
         Any way you can pass public, private or protected as argument to this function
         """
         matcher_base_t.__init__( self )

Modified: pygccxml_dev/pygccxml/declarations/namespace.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/namespace.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/namespace.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -58,7 +58,7 @@
         removes decl from  members list
 
         :param decl: declaration to be removed
-        :type decl: L{declaration_t}
+        :type decl: :class:declaration_t
         """
         del self.declarations[ self.declarations.index( decl ) ]
         decl.cache.reset()

Modified: pygccxml_dev/pygccxml/declarations/type_traits.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/type_traits.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/type_traits.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -12,7 +12,7 @@
     - modify type
 
 Those functions are very valuable for code generation. Almost all functions
-within this module works on L{type_t} class hierarchy and\\or L{class_t}.
+within this module works on :class:type_t class hierarchy and\\or :class:class_t.
 """
 
 import os

Modified: pygccxml_dev/pygccxml/declarations/typedef.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/typedef.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/typedef.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -32,7 +32,7 @@
     def _set_type(self, type):
         self._type = type
     type = property( _get_type, _set_type
-                     , doc="reference to the original L{type<type_t>}"    )
+                     , doc="reference to the original :class:`type <type_t>`"    )
 
     def i_depend_on_them( self, recursive=True ):
         return [ dependencies.dependency_info_t( self, self.type ) ]

Modified: pygccxml_dev/pygccxml/declarations/variable.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/variable.py	2009-02-02 18:31:43 UTC (rev 1650)
+++ pygccxml_dev/pygccxml/declarations/variable.py	2009-02-02 19:04:21 UTC (rev 1651)
@@ -41,7 +41,7 @@
     def _set_type(self, type):
         self._type = type
     type = property( _get_type, _set_type
-                     , doc="reference to the variable L{type<type_t>}"    )
+                     , doc="reference to the variable :class:`type <type_t>`"    )
 
     def _get_type_qualifiers(self):
         return self._type_qualifiers


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.