sphinx

Author: roman_yakovenko

docs/apidocs/binary_parsers.rest

@@ -8,6 +8,7 @@ Overview
 
 .. automodule:: pygccxml.binary_parsers
     :members:
+    :undoc-members:
     :show-inheritance:
 
 --------
@@ -19,4 +20,5 @@ parsers
 
 .. automodule:: pygccxml.binary_parsers.parsers
     :members:
+    :undoc-members:
     :show-inheritance:

docs/apidocs/declarations.rest

@@ -8,6 +8,7 @@ Overview
 
 .. automodule:: pygccxml.declarations
     :members:
+    :undoc-members:
     :show-inheritance:
 
 --------
@@ -19,173 +20,198 @@ algorithm
 
 .. automodule:: pygccxml.declarations.algorithm
     :members:
+    :undoc-members:
     :show-inheritance:
 
 algorithms_cache
 -------------------------
 
 .. automodule:: pygccxml.declarations.algorithms_cache
     :members:
+    :undoc-members:
     :show-inheritance:
 
 calldef
 ----------------
 
 .. automodule:: pygccxml.declarations.calldef
     :members:
+    :undoc-members:
     :show-inheritance:
 
 call_invocation
 ------------------------
 
 .. automodule:: pygccxml.declarations.call_invocation
     :members:
+    :undoc-members:
     :show-inheritance:
 
 class_declaration
 --------------------------
 
 .. automodule:: pygccxml.declarations.class_declaration
     :members:
+    :undoc-members:
     :show-inheritance:
 
 compilers
 ------------------
 
 .. automodule:: pygccxml.declarations.compilers
     :members:
+    :undoc-members:
     :show-inheritance:
 
 container_traits
 -------------------------
 
 .. automodule:: pygccxml.declarations.container_traits
     :members:
+    :undoc-members:
     :show-inheritance:
 
 cpptypes
 -----------------
 
 .. automodule:: pygccxml.declarations.cpptypes
     :members:
+    :undoc-members:
     :show-inheritance:
 
 declaration
 --------------------
 
 .. automodule:: pygccxml.declarations.declaration
     :members:
+    :undoc-members:
     :show-inheritance:
 
 decl_factory
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_factory
     :members:
+    :undoc-members:
     :show-inheritance:
 
 decl_printer
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_printer
     :members:
+    :undoc-members:
     :show-inheritance:
 
 decl_visitor
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_visitor
     :members:
+    :undoc-members:
     :show-inheritance:
 
 dependencies
 ---------------------
 
 .. automodule:: pygccxml.declarations.dependencies
     :members:
+    :undoc-members:
     :show-inheritance:
 
 enumeration
 --------------------
 
 .. automodule:: pygccxml.declarations.enumeration
     :members:
+    :undoc-members:
     :show-inheritance:
 
 function_traits
 ------------------------
 
 .. automodule:: pygccxml.declarations.function_traits
     :members:
+    :undoc-members:
     :show-inheritance:
 
 matcher
 ----------------
 
 .. automodule:: pygccxml.declarations.matcher
     :members:
+    :undoc-members:
     :show-inheritance:
 
 matchers
 -----------------
 
 .. automodule:: pygccxml.declarations.matchers
     :members:
+    :undoc-members:
     :show-inheritance:
 
 mdecl_wrapper
 ----------------------
 
 .. automodule:: pygccxml.declarations.mdecl_wrapper
     :members:
+    :undoc-members:
     :show-inheritance:
 
 namespace
 ------------------
 
 .. automodule:: pygccxml.declarations.namespace
     :members:
+    :undoc-members:
     :show-inheritance:
 
 scopedef
 -----------------
 
 .. automodule:: pygccxml.declarations.scopedef
     :members:
+    :undoc-members:
     :show-inheritance:
 
 templates
 ------------------
 
 .. automodule:: pygccxml.declarations.templates
     :members:
+    :undoc-members:
     :show-inheritance:
 
 typedef
 ----------------
 
 .. automodule:: pygccxml.declarations.typedef
     :members:
+    :undoc-members:
     :show-inheritance:
 
 type_traits
 --------------------
 
 .. automodule:: pygccxml.declarations.type_traits
     :members:
+    :undoc-members:
     :show-inheritance:
 
 type_visitor
 ---------------------
 
 .. automodule:: pygccxml.declarations.type_visitor
     :members:
+    :undoc-members:
     :show-inheritance:
 
 variable
 ---------------
 
 .. automodule:: pygccxml.declarations.variable
     :members:
+    :undoc-members:
     :show-inheritance:
 

docs/apidocs/parser.rest

@@ -8,6 +8,7 @@ Overview
 
 .. automodule:: pygccxml.parser
     :members:
+    :undoc-members:
     :show-inheritance:
 
 --------
@@ -19,34 +20,39 @@ config
 
 .. automodule:: pygccxml.parser.config
     :members:
+    :undoc-members:
     :show-inheritance:
 
 declarations_cache
 ----------------------------
 
 .. automodule:: pygccxml.parser.declarations_cache
     :members:
+    :undoc-members:
     :show-inheritance:
 
 directory_cache
 ------------------------
 
 .. automodule:: pygccxml.parser.directory_cache
     :members:
+    :undoc-members:
     :show-inheritance:
 
 patcher
 ----------------
 
 .. automodule:: pygccxml.parser.patcher
     :members:
+    :undoc-members:
     :show-inheritance:
 
 project_reader
 ---------------------
 
 .. automodule:: pygccxml.parser.project_reader
     :members:
+    :undoc-members:
     :show-inheritance:
 
 
@@ -55,4 +61,5 @@ source_reader
 
 .. automodule:: pygccxml.parser.source_reader
     :members:
+    :undoc-members:
     :show-inheritance:

docs/apidocs/utils.rest

@@ -8,6 +8,7 @@ Overview
 
 .. automodule:: pygccxml.utils
     :members:
+    :undoc-members:
     :show-inheritance:
 
 --------
@@ -19,5 +20,6 @@ fs_utils
 
 .. automodule:: pygccxml.utils.fs_utils
     :members:
+    :undoc-members:
     :show-inheritance:
 

pygccxml/declarations/container_traits.py

@@ -243,16 +243,16 @@ def erase_hashmap_compare_allocator( cls_name ):
 
 
 class container_traits_impl_t:
-    """this class implements the functionality needed for convenient work with
-    STD container classes.
+    """
+    implements the functionality needed for convenient work with STD container classes
 
     Implemented functionality:
-        - find out whether a declaration is STD container or not
-        - find out container value( mapped ) type
+      * find out whether a declaration is STD container or not
+      * find out container value( mapped ) type
 
     This class tries to be useful as much, as possible. For example, for class
     declaration( and not definition ) it parsers the class name in order to
-    extract all the information.
+    extract the information.
     """
     def __init__( self
                   , container_name
@@ -262,12 +262,11 @@ def __init__( self
                   , key_type_index=None
                   , key_type_typedef=None ):
         """
-        container_name - std container name
-        element_type_index - position of value\\mapped type within template
-          arguments list
-        element_type_typedef - class typedef to the value\\mapped type
-        key_type_index - position of key type within template arguments list
-        key_type_typedef - class typedef to the key type
+        :param container_name: std container name
+        :param element_type_index: position of value\\mapped type within template arguments list
+        :param element_type_typedef: class typedef to the value\\mapped type
+        :param key_type_index: position of key type within template arguments list
+        :param key_type_typedef: class typedef to the key type
         """
         self._name = container_name
         self.remove_defaults_impl = defaults_remover
@@ -353,12 +352,18 @@ def key_type( self, type_ ):
                                      , 'container_key_type' )
 
     def remove_defaults( self, type_or_string ):
-        """remove template defaults from a template class instantiation
+        """
+        removes template defaults from a template class instantiation
 
         For example:
-            std::vector< int, std::allocator< int > >
+            .. code-block:: c++
+
+               std::vector< int, std::allocator< int > >
+
         will become
-            std::vector< int >
+            .. code-block:: c++
+
+               std::vector< int >
         """
         name = type_or_string
         if not isinstance( type_or_string, types.StringTypes ):

pygccxml/declarations/matchers.py

@@ -321,10 +321,10 @@ def __call__( self, decl ):
 
 class calldef_matcher_t( declaration_matcher_t ):
     """
-    Instance of this class will match callable by next criteria:
-        - :class:`declaration_matcher_t` criteria
-        - return type. Example: :class:`int_t` or 'int'
-        - argument types
+    Instance of this class will match callable by the following criteria:
+        * :class:`declaration_matcher_t` criteria
+        * return type. For example: :class:`int_t` or 'int'
+        * argument types
     """
 
     def __init__( self, name=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None):
@@ -407,8 +407,8 @@ def __str__( self ):
 class operator_matcher_t( calldef_matcher_t ):
     """
     Instance of this class will match operators by next criteria:
-        - :class:`calldef_matcher_t` criteria
-        - operator symbol: =, !=, (), [] and etc
+        * :class:`calldef_matcher_t` criteria
+        * operator symbol: =, !=, (), [] and etc
     """
     def __init__( self, name=None, symbol=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None):
         """
@@ -479,14 +479,13 @@ class access_type_matcher_t( matcher_base_t ):
     """
     Instance of this class will match declaration by its access type: public,
     private or protected. If declarations does not have access type, for example
-    free function, then False will be returned.
+    free function, then `False` will be returned.
     """
 
     def __init__( self, access_type ):
         """
-        :param access_type: declaration access type
-        :type access_type: :class:ACCESS_TYPES defines few constants for your convenience.
-        Any way you can pass public, private or protected as argument to this function
+        :param access_type: declaration access type, could be "public", "private", "protected"
+        :type access_type: :class: `str`
         """
         matcher_base_t.__init__( self )
         self.access_type = access_type