Improve some docstrings, removes sphinx warnings.

Author: iMichka

pygccxml/declarations/algorithm.py

@@ -128,9 +128,8 @@ def make_flatten(decl_or_decls):
     converts tree representation of declarations to flatten one.
 
     :param decl_or_decls: reference to list of declaration's or single
-    declaration
+        declaration
     :type decl_or_decls: :class:`declaration_t` or [ :class:`declaration_t` ]
-
     :rtype: [ all internal declarations ]
     """
     import pygccxml.declarations  # prevent cyclic import
@@ -206,7 +205,7 @@ class match_declaration_t:
 
     This class will help developer to match declaration by:
         - declaration type, for example :class:`class_t` or
-        :class:`operator_t`.
+            :class:`operator_t`.
         - declaration name
         - declaration full name
         - reference to parent declaration
@@ -343,10 +342,9 @@ def declaration_files(decl_or_decls):
     contains all file names of declarations.
 
     :param decl_or_decls: reference to list of declaration's or single
-    declaration
-    :type decl_or_decls: :class:`declaration_t` or [ :class:`declaration_t` ]
-
-    :rtype: set( declaration file names )
+        declaration
+    :type decl_or_decls: :class:`declaration_t` or [:class:`declaration_t`]
+    :rtype: set(declaration file names)
     """
     files = set()
     decls = make_flatten(decl_or_decls)
@@ -359,7 +357,7 @@ def declaration_files(decl_or_decls):
 class visit_function_has_not_been_found_t(RuntimeError):
 
     """
-    exception that is raised, from :func:`apply_visitor`, when a visitor could
+    Exception that is raised, from :func:`apply_visitor`, when a visitor could
     not be applied.
 
     """

pygccxml/declarations/decl_printer.py

@@ -482,7 +482,7 @@ def print_declarations(
     print declarations tree rooted at each of the included nodes.
 
     :param decls: either a single :class:declaration_t object or list
-    of :class:declaration_t objects
+        of :class:declaration_t objects
     """
     prn = decl_printer_t(0, detailed, recursive, writer, verbose=verbose)
     if not isinstance(decls, list):
@@ -498,7 +498,7 @@ def dump_declarations(decls, fpath):
     dump declarations tree rooted at each of the included nodes to the file
 
     :param decls: either a single :class:declaration_t object or list
-    of :class:declaration_t objects
+        of :class:declaration_t objects
     :param fpath: file name
     """
     fobj = open(fpath, 'w+')

pygccxml/declarations/matcher.py

@@ -3,20 +3,20 @@
 # Distributed under the Boost Software License, Version 1.0.
 # See http://www.boost.org/LICENSE_1_0.txt
 
-"""implements few "find" algorithms on declarations tree"""
+"""Implements few "find" algorithms on declarations tree"""
 
 import types
 from . import algorithm
 
 
 class matcher:
 
-    """class-namespace, contains implementation of few "find" algorithms and
+    """Class-namespace, contains implementation of few "find" algorithms and
     definition of related exception classes"""
 
     class declaration_not_found_t(RuntimeError):
 
-        """exception, that will be raised, if the declaration could not be
+        """Exception, that will be raised, if the declaration could not be
         found"""
 
         def __init__(self, matcher):
@@ -31,7 +31,7 @@ def __str__(self):
 
     class multiple_declarations_found_t(RuntimeError):
 
-        """exception, that will be raised, if more than one declaration was
+        """Exception, that will be raised, if more than one declaration was
         found"""
 
         def __init__(self, matcher):
@@ -47,15 +47,15 @@ def __str__(self):
     @staticmethod
     def find(decl_matcher, decls, recursive=True):
         """
-        returns a list of declarations that match `decl_matcher` defined
+        Returns a list of declarations that match `decl_matcher` defined
         criteria or None
 
         :param decl_matcher: Python callable object, that takes one argument -
-        reference to a declaration
+            reference to a declaration
         :param decls: the search scope, :class:declaration_t object or
-        :class:declaration_t objects list t
+            :class:declaration_t objects list t
         :param recursive: boolean, if True, the method will run `decl_matcher`
-        on the internal declarations too
+            on the internal declarations too
         """
 
         where = []
@@ -70,17 +70,17 @@ def find(decl_matcher, decls, recursive=True):
     @staticmethod
     def find_single(decl_matcher, decls, recursive=True):
         """
-        returns a reference to the declaration, that match `decl_matcher`
+        Returns a reference to the declaration, that match `decl_matcher`
         defined criteria.
 
         if a unique declaration could not be found the method will return None.
 
         :param decl_matcher: Python callable object, that takes one argument -
-        reference to a declaration
+            reference to a declaration
         :param decls: the search scope, :class:declaration_t object or
-        :class:declaration_t objects list t
+            :class:declaration_t objects list t
         :param recursive: boolean, if True, the method will run `decl_matcher`
-        on the internal declarations too
+            on the internal declarations too
         """
         answer = matcher.find(decl_matcher, decls, recursive)
         if len(answer) == 1:
@@ -89,18 +89,18 @@ def find_single(decl_matcher, decls, recursive=True):
     @staticmethod
     def get_single(decl_matcher, decls, recursive=True):
         """
-        returns a reference to declaration, that match `decl_matcher` defined
+        Returns a reference to declaration, that match `decl_matcher` defined
         criteria.
 
         If a unique declaration could not be found, an appropriate exception
         will be raised.
 
         :param decl_matcher: Python callable object, that takes one argument -
-        reference to a declaration
+            reference to a declaration
         :param decls: the search scope, :class:declaration_t object or
-        :class:declaration_t objects list t
+            :class:declaration_t objects list t
         :param recursive: boolean, if True, the method will run `decl_matcher`
-        on the internal declarations too
+            on the internal declarations too
         """
         answer = matcher.find(decl_matcher, decls, recursive)
         if len(answer) == 1:

pygccxml/declarations/scopedef.py

@@ -3,7 +3,7 @@
 # Distributed under the Boost Software License, Version 1.0.
 # See http://www.boost.org/LICENSE_1_0.txt
 
-"""defines :class:`scopedef_t` class"""
+"""Defines :class:`scopedef_t` class"""
 
 import time
 from . import algorithm
@@ -33,7 +33,7 @@ class scopedef_t(declaration.declaration_t):
 
         2. `header_dir` - directory, to which belongs file, that the
             declaration was declared in.
-           `header_dir` should be absolute path.
+            `header_dir` should be absolute path.
 
         3. `header_file` - file that the declaration was declared in.