sphinx

Author: roman_yakovenko

pygccxml/declarations/type_traits.py

@@ -254,9 +254,9 @@ def remove_const(type):
         return nake_type.base
 
 def remove_declarated( type_ ):
-    """removes type-declaration class-binder :class:`declarated_t` from the type_
+    """removes type-declaration class-binder :class:`declarated_t` from the `type_`
 
-    If type_ is not :class:`declarated_t`, it will be returned as is
+    If `type_` is not :class:`declarated_t`, it will be returned as is
     """
     type_ = remove_alias( type_ )
     if isinstance( type_, cpptypes.declarated_t ):
@@ -426,7 +426,7 @@ def has_any_non_copyconstructor( type):
         return decls
 
 def has_public_binary_operator( type_, operator_symbol ):
-    """returns True, if type_ has public binary operator, otherwise False"""
+    """returns True, if `type_` has public binary operator, otherwise False"""
     not_artificial = lambda decl: not decl.is_artificial
     type_ = remove_alias( type_ )
     type_ = remove_cv( type_ )

pygccxml/parser/directory_cache.py

@@ -460,7 +460,7 @@ def release_filename(self, id_):
             del self.__id_lut[entry.filename]
 
     def is_file_modified(self, id_, signature):
-        """Check if the file referred to by id_ has been modified.
+        """Check if the file referred to by `id_` has been modified.
         """
         entry = self.__entries.get(id_)
         if entry==None:
@@ -479,7 +479,7 @@ def is_file_modified(self, id_, signature):
         return filesig!=signature
 
     def update_id_counter(self):
-        """Update the id_ counter so that it doesn't grow forever.
+        """Update the `id_` counter so that it doesn't grow forever.
         """
         if len(self.__entries)==0:
             self.__next_id = 1

pygccxml/parser/source_reader.py

@@ -57,7 +57,7 @@ class source_reader_t:
     to two classes:
 
     1. `scanner_t` - this class scans the "XML" file, generated by GCC-XML and
-       creates `pygccxml`_ declarations and types classes. After the XML file has
+       creates :mod:`pygccxml` declarations and types classes. After the XML file has
        been processed declarations and type class instances keeps references to
        each other using GCC-XML generated id's.