[pygccxml-commit] SF.net SVN: pygccxml:[1650] pyplusplus_dev/pyplusplus
Brought to you by:
mbaas,
roman_yakovenko
Menu
▾
▴
[pygccxml-commit] SF.net SVN: pygccxml:[1650] pyplusplus_dev/pyplusplus
|
From: <rom...@us...> - 2009-02-02 18:31:48
|
Revision: 1650
http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1650&view=rev
Author: roman_yakovenko
Date: 2009-02-02 18:31:43 +0000 (Mon, 02 Feb 2009)
Log Message:
-----------
sphinx - correct documentation string
Modified Paths:
--------------
pydsc_dev/pydsc.py
pygccxml_dev/docs/apidocs/api.rest
pygccxml_dev/docs/apidocs/binary_parsers.rest
pygccxml_dev/docs/apidocs/declarations.rest
pygccxml_dev/docs/apidocs/parser.rest
pygccxml_dev/docs/apidocs/utils.rest
pygccxml_dev/pygccxml/declarations/__init__.py
pygccxml_dev/pygccxml/declarations/algorithm.py
pygccxml_dev/pygccxml/declarations/call_invocation.py
pygccxml_dev/pygccxml/declarations/class_declaration.py
pygccxml_dev/pygccxml/declarations/cpptypes.py
pygccxml_dev/pygccxml/declarations/enumeration.py
pygccxml_dev/pygccxml/declarations/matcher.py
pygccxml_dev/pygccxml/declarations/matchers.py
pygccxml_dev/pygccxml/declarations/mdecl_wrapper.py
pygccxml_dev/pygccxml/declarations/namespace.py
pygccxml_dev/pygccxml/declarations/scopedef.py
pygccxml_dev/pygccxml/declarations/templates.py
pygccxml_dev/pygccxml/parser/__init__.py
pygccxml_dev/pygccxml/parser/declarations_cache.py
pygccxml_dev/pygccxml/parser/directory_cache.py
pygccxml_dev/pygccxml/parser/project_reader.py
pygccxml_dev/pygccxml/parser/source_reader.py
pygccxml_dev/unittests/data/core_cache.hpp
pyplusplus_dev/pyplusplus/code_creators/calldef_transformed.py
pyplusplus_dev/pyplusplus/code_creators/code_creator.py
pyplusplus_dev/pyplusplus/code_creators/compound.py
pyplusplus_dev/pyplusplus/code_creators/declaration_based.py
pyplusplus_dev/pyplusplus/code_creators/module.py
pyplusplus_dev/pyplusplus/creators_factory/bpcreator.py
pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py
pyplusplus_dev/pyplusplus/decl_wrappers/class_wrapper.py
pyplusplus_dev/pyplusplus/file_writers/balanced_files.py
pyplusplus_dev/pyplusplus/file_writers/multiple_files.py
pyplusplus_dev/pyplusplus/file_writers/writer.py
pyplusplus_dev/pyplusplus/function_transformers/controllers.py
pyplusplus_dev/pyplusplus/function_transformers/transformer.py
pyplusplus_dev/pyplusplus/function_transformers/transformers.py
pyplusplus_dev/pyplusplus/module_builder/boost_python_builder.py
pyplusplus_dev/pyplusplus/module_builder/ctypes_builder.py
pyplusplus_dev/pyplusplus/module_builder/module_builder.py
Modified: pydsc_dev/pydsc.py
===================================================================
--- pydsc_dev/pydsc.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pydsc_dev/pydsc.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -66,13 +66,13 @@
"""
returns true if one of the directories is root directory for the `path`, false otherwise
- @param path: path
- @type path: str
+ :param path: path
+ :type path: str
- @param dirs: list of directories and\\or files
- @type dirs: [ str ]
+ :param dirs: list of directories and\\or files
+ :type dirs: [ str ]
- @return: bool
+ :rtype: bool
"""
#precondition: dirs and fpath should be normalize_path'ed before calling this function
return bool( filter( lambda dir: path.startswith( dir ), dirs ) )
@@ -106,23 +106,23 @@
saved in one of the members of the class, and replaced with import_
member function.
- @param speller: reference to enchant.checker.SpellChecker object
- @type speller: enchant.checker.SpellChecker
+ :param speller: reference to enchant.checker.SpellChecker object
+ :type speller: enchant.checker.SpellChecker
- @param writer: reference to instance of class that has write method.
+ :param writer: reference to instance of class that has write method.
By default sys.stdout will be used.
- @param filter: list of files or directories
- @type filter: [ str ]
+ :param filter: list of files or directories
+ :type filter: [ str ]
- @param filter_type: provides interpretation for content of filter parameter
- @type filter_type: L{FILTER_TYPE}
+ :param filter_type: provides interpretation for content of filter parameter
+ :type filter_type: L{FILTER_TYPE}
- @param ignore_identifiers: often comments/documentation strings contains
+ :param ignore_identifiers: often comments/documentation strings contains
class\\method\\function names. Those names,
usually introduce spell error. If ignore_identifiers
set to True, those names will be ignored.
- @type ignore_identifiers: bool
+ :type ignore_identifiers: bool
"""
object.__init__( self )
self.__checked = set()
Modified: pygccxml_dev/docs/apidocs/api.rest
===================================================================
--- pygccxml_dev/docs/apidocs/api.rest 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/docs/apidocs/api.rest 2009-02-02 18:31:43 UTC (rev 1650)
@@ -7,7 +7,7 @@
.. toctree::
:maxdepth: 4
- declarations - contains classes, which describe C++ declarations <declarations>
- parser - contains classes, which parse GCC-XML generated file <parser>
- binary_parsers - contains classes, which extract some information from `.dll`, `.map`, `.so` files <binary_parsers>
- utils - few useful utilities <utils>
+ declarations.rest
+ parser.rest
+ binary_parsers.rest
+ utils.rest
Modified: pygccxml_dev/docs/apidocs/binary_parsers.rest
===================================================================
--- pygccxml_dev/docs/apidocs/binary_parsers.rest 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/docs/apidocs/binary_parsers.rest 2009-02-02 18:31:43 UTC (rev 1650)
@@ -1,23 +1,10 @@
-===============================
-pygccxml.binary_parsers package
-===============================
+===========================
+pygccxml.binary_parsers API
+===========================
-This page contains the `pygccxml.binary_parsers` package API documentation.
+parsers
+-------
-The :mod:`pygccxml.binary_parsers` package
-------------------------------------------
-
-.. automodule:: pygccxml.binary_parsers
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-The :mod:`parsers <pygccxml.binary_parsers.parsers>` module
------------------------------------------------------------
-
.. automodule:: pygccxml.binary_parsers.parsers
:members:
- :undoc-members:
:show-inheritance:
-
Modified: pygccxml_dev/docs/apidocs/declarations.rest
===================================================================
--- pygccxml_dev/docs/apidocs/declarations.rest 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/docs/apidocs/declarations.rest 2009-02-02 18:31:43 UTC (rev 1650)
@@ -2,187 +2,176 @@
pygccxml.declarations package
=============================
-This page contains the `pygccxml.declarations` package API documentation.
+algorithm
+---------
-The :mod:`pygccxml.declarations` package
-----------------------------------------
-
-.. automodule:: pygccxml.declarations
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-The :mod:`algorithm <pygccxml.declarations.algorithm>` module
---------------------------------------------------------------
-
.. automodule:: pygccxml.declarations.algorithm
:members:
:show-inheritance:
-The :mod:`algorithms_cache <pygccxml.declarations.algorithms_cache>` module
----------------------------------------------------------------------------
+algorithms_cache
+----------------
.. automodule:: pygccxml.declarations.algorithms_cache
:members:
:show-inheritance:
-The :mod:`calldef <pygccxml.declarations.calldef>` module
----------------------------------------------------------
+calldef
+-------
.. automodule:: pygccxml.declarations.calldef
:members:
:show-inheritance:
-The :mod:`call_invocation <pygccxml.declarations.call_invocation>` module
--------------------------------------------------------------------------
+call_invocation
+---------------
.. automodule:: pygccxml.declarations.call_invocation
:members:
:show-inheritance:
-The :mod:`class_declaration <pygccxml.declarations.class_declaration>` module
------------------------------------------------------------------------------
+class_declaration
+-----------------
.. automodule:: pygccxml.declarations.class_declaration
:members:
:show-inheritance:
-The :mod:`compilers <pygccxml.declarations.compilers>` module
--------------------------------------------------------------
+compilers
+---------
.. automodule:: pygccxml.declarations.compilers
:members:
:show-inheritance:
-The :mod:`container_traits <pygccxml.declarations.container_traits>` module
----------------------------------------------------------------------------
+container_traits
+----------------
.. automodule:: pygccxml.declarations.container_traits
:members:
:show-inheritance:
-The :mod:`cpptypes <pygccxml.declarations.cpptypes>` module
------------------------------------------------------------
+cpptypes
+--------
.. automodule:: pygccxml.declarations.cpptypes
:members:
:show-inheritance:
-The :mod:`declaration <pygccxml.declarations.declaration>` module
------------------------------------------------------------------
+declaration
+-----------
.. automodule:: pygccxml.declarations.declaration
:members:
:show-inheritance:
-The :mod:`decl_factory <pygccxml.declarations.decl_factory>` module
--------------------------------------------------------------------
+decl_factory
+------------
.. automodule:: pygccxml.declarations.decl_factory
:members:
:show-inheritance:
-The :mod:`decl_printer <pygccxml.declarations.decl_printer>` module
--------------------------------------------------------------------
+ecl_printer
+-----------
.. automodule:: pygccxml.declarations.decl_printer
:members:
:show-inheritance:
-The :mod:`decl_visitor <pygccxml.declarations.decl_visitor>` module
---------------------------------------------------------------------
+decl_visitor
+------------
.. automodule:: pygccxml.declarations.decl_visitor
:members:
:show-inheritance:
-The :mod:`dependencies <pygccxml.declarations.dependencies>` module
---------------------------------------------------------------------
+dependencies
+------------
.. automodule:: pygccxml.declarations.dependencies
:members:
:show-inheritance:
-The :mod:`enumeration <pygccxml.declarations.enumeration>` module
-------------------------------------------------------------------
+enumeration
+-----------
.. automodule:: pygccxml.declarations.enumeration
:members:
:show-inheritance:
-The :mod:`function_traits <pygccxml.declarations.function_traits>` module
--------------------------------------------------------------------------
+function_traits
+---------------
.. automodule:: pygccxml.declarations.function_traits
:members:
:show-inheritance:
-The :mod:`matcher <pygccxml.declarations.matcher>` module
----------------------------------------------------------
+matcher
+-------
.. automodule:: pygccxml.declarations.matcher
:members:
:show-inheritance:
-The :mod:`matchers <pygccxml.declarations.matchers>` module
------------------------------------------------------------
+matchers
+--------
.. automodule:: pygccxml.declarations.matchers
:members:
:show-inheritance:
-The :mod:`mdecl_wrapper <pygccxml.declarations.mdecl_wrapper>` module
----------------------------------------------------------------------
+mdecl_wrapper
+-------------
.. automodule:: pygccxml.declarations.mdecl_wrapper
:members:
:show-inheritance:
-The :mod:`namespace <pygccxml.declarations.namespace>` module
--------------------------------------------------------------
+namespace
+---------
.. automodule:: pygccxml.declarations.namespace
:members:
:show-inheritance:
-The :mod:`scopedef <pygccxml.declarations.scopedef>` module
------------------------------------------------------------
+scopedef
+--------
.. automodule:: pygccxml.declarations.scopedef
:members:
:show-inheritance:
-The :mod:`templates <pygccxml.declarations.templates>` module
--------------------------------------------------------------
+templates
+---------
.. automodule:: pygccxml.declarations.templates
:members:
:show-inheritance:
-The :mod:`typedef <pygccxml.declarations.typedef>` module
----------------------------------------------------------
+typedef
+-------
.. automodule:: pygccxml.declarations.typedef
:members:
:show-inheritance:
-The :mod:`type_traits <pygccxml.declarations.type_traits>` module
------------------------------------------------------------------
+type_traits
+-----------
.. automodule:: pygccxml.declarations.type_traits
:members:
:show-inheritance:
-The :mod:`type_visitor <pygccxml.declarations.type_visitor>` module
--------------------------------------------------------------------
+type_visitor
+------------
.. automodule:: pygccxml.declarations.type_visitor
:members:
:show-inheritance:
-The :mod:`variable <pygccxml.declarations.variable>` module
------------------------------------------------------------
+variable
+--------
.. automodule:: pygccxml.declarations.variable
:members:
Modified: pygccxml_dev/docs/apidocs/parser.rest
===================================================================
--- pygccxml_dev/docs/apidocs/parser.rest 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/docs/apidocs/parser.rest 2009-02-02 18:31:43 UTC (rev 1650)
@@ -2,54 +2,45 @@
pygccxml.parser package
=======================
-This page contains the `pygccxml.parser` package API documentation.
+config
+------
-The :mod:`pygccxml.parser` Package
-----------------------------------------------------------
-
-.. automodule:: pygccxml.parser
+.. automodule:: pygccxml.parser.config
:members:
- :undoc-members:
:show-inheritance:
-The :mod:`config <pygccxml.parser.config>` module
--------------------------------------------------
+declarations_cache
+------------------
-.. automodule:: pygccxml.parser.config
+.. automodule:: pygccxml.parser.declarations_cache
:members:
- :undoc-members:
:show-inheritance:
-The :mod:`declarations_cache <pygccxml.parser.declarations_cache>` module
---------------------------------------------------------------------------
+directory_cache
+---------------
-.. automodule:: pygccxml.parser.declarations_cache
+.. automodule:: pygccxml.parser.directory_cache
:members:
- :undoc-members:
:show-inheritance:
+patcher
+-------
-The :mod:`pygccxml.parser.patcher` module
------------------------------------------
-
.. automodule:: pygccxml.parser.patcher
:members:
- :undoc-members:
:show-inheritance:
-The :mod:`project_reader <pygccxml.parser.project_reader>` module
------------------------------------------------------------------
+project_reader
+--------------
.. automodule:: pygccxml.parser.project_reader
:members:
- :undoc-members:
:show-inheritance:
-The :mod:`source_reader <pygccxml.parser.source_reader>` module
------------------------------------------------
+source_reader
+-------------
+
.. automodule:: pygccxml.parser.source_reader
:members:
- :undoc-members:
:show-inheritance:
-
Modified: pygccxml_dev/docs/apidocs/utils.rest
===================================================================
--- pygccxml_dev/docs/apidocs/utils.rest 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/docs/apidocs/utils.rest 2009-02-02 18:31:43 UTC (rev 1650)
@@ -2,23 +2,11 @@
pygccxml.utils package
======================
-This page contains the `pygccxml.utils` package API documentation.
-The :mod:`pygccxml.utils` package
----------------------------------
+fs_utils
+--------
-.. automodule:: pygccxml.utils
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-
-The :mod:`utils.fs_utils` module
----------------------------------
-
.. automodule:: pygccxml.utils.fs_utils
:members:
- :undoc-members:
:show-inheritance:
Modified: pygccxml_dev/pygccxml/declarations/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/__init__.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/__init__.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -3,9 +3,7 @@
# accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
-"""
-contains classes that describe different C++ declarations
-"""
+"""contains classes that describe different C++ declarations"""
import compilers
Modified: pygccxml_dev/pygccxml/declarations/algorithm.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/algorithm.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/algorithm.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -11,10 +11,10 @@
"""
returns a list of parent declarations names
- @param decl: declaration for which declaration path should be calculated
- @type decl: L{declaration_t}
+ :param decl: declaration for which declaration path should be calculated
+ :type decl: L{declaration_t}
- @return: [names], where first item contains top parent name and last item
+ :rtype: [names], where first item contains top parent name and last item
contains decl name
"""
if not decl:
@@ -41,10 +41,10 @@
returns a list of parent declarations names without template arguments that
have default value
- @param decl: declaration for which declaration path should be calculated
- @type decl: L{declaration_t}
+ :param decl: declaration for which declaration path should be calculated
+ :type decl: L{declaration_t}
- @return: [names], where first item contains top parent name and last item
+ :rtype: [names], where first item contains top parent name and last item
contains decl name
"""
#TODO:
@@ -74,10 +74,10 @@
"""
returns a reference to a named parent declaration
- @param decl: the child declaration
- @type decl: L{declaration_t}
+ :param decl: the child declaration
+ :type decl: L{declaration_t}
- @return: reference to L{declaration_t} or None if not found
+ :rtype: reference to L{declaration_t} or None if not found
"""
if not decl:
return None
@@ -98,12 +98,12 @@
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
+ :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}
+ :type decl: L{declaration_t}
- @return: full name of declarations.
+ :rtype: full name of declarations.
"""
if None is decl:
raise RuntimeError( "Unable to generate full name for None object!" )
@@ -121,10 +121,10 @@
"""
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} ]
+ :param decl_or_decls: reference to list of declaration's or single declaration
+ :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
- @return: [ all internal declarations ]
+ :rtype: [ all internal declarations ]
"""
import pygccxml.declarations #prevent cyclic import
def proceed_single( decl ):
@@ -152,10 +152,10 @@
"""
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} ]
+ :param decl_or_decls: reference to list of declaration's or single declaration
+ :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
- @return: [ all internal declarations ]
+ :rtype: [ all internal declarations ]
"""
import pygccxml.declarations
@@ -208,10 +208,10 @@
"""
returns True if inst do match one of specified criteria
- @param inst: declaration instance
- @type inst: L{declaration_t}
+ :param inst: declaration instance
+ :type inst: L{declaration_t}
- @return: bool
+ :rtype: bool
"""
answer = True
if None != self.type:
@@ -242,7 +242,7 @@
For more information about arguments see L{match_declaration_t} class.
- @return: [ matched declarations ]
+ :rtype: [ matched declarations ]
"""
decls = []
if recursive:
@@ -264,7 +264,7 @@
For more information about arguments see L{match_declaration_t} class.
- @return: matched declaration L{declaration_t} or None
+ :rtype: matched declaration L{declaration_t} or None
"""
decl = find_all_declarations( declarations, type=type, name=name, parent=parent, recursive=recursive, fullname=fullname )
if len( decl ) == 1:
@@ -276,7 +276,7 @@
For more information about arguments see L{match_declaration_t} class.
- @return: matched declaration L{declaration_t} or None
+ :rtype: matched declaration L{declaration_t} or None
"""
matcher = match_declaration_t(type, name, fullname, parent)
if recursive:
@@ -295,10 +295,10 @@
Every declaration is declared in some file. This function returns set, that
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} ]
+ :param decl_or_decls: reference to list of declaration's or single declaration
+ :type decl_or_decls: L{declaration_t} or [ L{declaration_t} ]
- @return: set( declaration file names )
+ :rtype: set( declaration file names )
"""
files = set()
decls = make_flatten( decl_or_decls )
@@ -325,8 +325,8 @@
"""
applies a visitor on declaration instance
- @param visitor: instance
- @type visitor: L{type_visitor_t} or L{decl_visitor_t}
+ :param visitor: instance
+ :type visitor: L{type_visitor_t} or L{decl_visitor_t}
"""
fname = 'visit_' + decl_inst.__class__.__name__[:-2] #removing '_t' from class name
if not hasattr(visitor, fname ):
Modified: pygccxml_dev/pygccxml/declarations/call_invocation.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/call_invocation.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/call_invocation.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -27,10 +27,10 @@
"""
returns True if `decl_string` is function invocation and False otherwise
- @param decl_string: string that should be checked for pattern presence
- @type decl_string: str
+ :param decl_string: string that should be checked for pattern presence
+ :type decl_string: str
- @return: bool
+ :rtype: bool
"""
global __THE_PARSER
return __THE_PARSER.has_pattern( decl_string )
@@ -39,8 +39,8 @@
"""
returns name of function
- @type decl_string: str
- @return: str
+ :type decl_string: str
+ :rtype: str
"""
global __THE_PARSER
return __THE_PARSER.name( decl_string )
@@ -49,8 +49,8 @@
"""
returns list of function arguments
- @type decl_string: str
- @return: [str]
+ :type decl_string: str
+ :rtype: [str]
"""
global __THE_PARSER
return __THE_PARSER.args( decl_string )
@@ -60,8 +60,8 @@
"""
finds arguments within function invocation.
- @type text: str
- @return: [ arguments ] or L{NOT_FOUND} if arguments could not be found
+ :type text: str
+ :rtype: [ arguments ] or L{NOT_FOUND} if arguments could not be found
"""
global __THE_PARSER
return __THE_PARSER.find_args( text, start )
Modified: pygccxml_dev/pygccxml/declarations/class_declaration.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/class_declaration.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/class_declaration.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -363,10 +363,10 @@
You should not modify the list content, otherwise different optimization
data will stop work and may to give you wrong results.
- @param access: describes desired members
- @type access: L{ACCESS_TYPES}
+ :param access: describes desired members
+ :type access: L{ACCESS_TYPES}
- @return: [ members ]
+ :rtype: [ members ]
"""
if access == ACCESS_TYPES.PUBLIC:
return self.public_members
@@ -384,10 +384,10 @@
def adopt_declaration( self, decl, access ):
"""adds new declaration to the class
- @param decl: reference to a L{declaration<declaration_t>}
+ :param decl: reference to a L{declaration<declaration_t>}
- @param access: member access type
- @type access: L{ACCESS_TYPES}
+ :param access: member access type
+ :type access: L{ACCESS_TYPES}
"""
if access == ACCESS_TYPES.PUBLIC:
self.public_members.append( decl )
@@ -405,8 +405,8 @@
"""
removes decl from members list
- @param decl: declaration to be removed
- @type decl: L{declaration_t}
+ :param decl: declaration to be removed
+ :type decl: L{declaration_t}
"""
container = None
access_type = self.find_out_member_access_type( decl )
@@ -423,10 +423,10 @@
"""
returns member access type
- @param member: member of the class
- @type member: L{declaration_t}
+ :param member: member of the class
+ :type member: L{declaration_t}
- @return: L{ACCESS_TYPES}
+ :rtype: L{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 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/cpptypes.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -494,12 +494,12 @@
"""
returns free function type
- @param return_type: function return type
- @type return_type: L{type_t}
+ :param return_type: function return type
+ :type return_type: L{type_t}
- @param arguments_types: list of argument L{type<type_t>}
+ :param arguments_types: list of argument L{type<type_t>}
- @return: L{free_function_type_t}
+ :rtype: L{free_function_type_t}
"""
f = lambda x: x.build_decl_string( with_defaults )
return free_function_type_t.NAME_TEMPLATE % {
@@ -520,7 +520,7 @@
def create_typedef( self, typedef_name, unused=None, with_defaults=True):
"""returns string, that contains valid C++ code, that defines typedef to function type
- @param name: the desired name of typedef
+ :param name: the desired name of typedef
"""
#unused argument simplifies user code
f = lambda x: x.build_decl_string( with_defaults )
@@ -558,8 +558,8 @@
def create_typedef( self, typedef_name, class_alias=None, with_defaults=True):
"""creates typedef to the function type
- @param typedef_name: desired type name
- @return: string
+ :param typedef_name: desired type name
+ :rtype: string
"""
has_const_str = ''
if self.has_const:
Modified: pygccxml_dev/pygccxml/declarations/enumeration.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/enumeration.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/enumeration.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -22,12 +22,12 @@
The items of the list 'values' may either be strings containing
the enumeration value name or tuples (name, numvalue).
- @param name: Enum name
- @type name: str
- @param parent: Parent declaration
- @type parent: declaration_t
- @param values: Enumeration values
- @type values: list
+ :param name: Enum name
+ :type name: str
+ :param parent: Parent declaration
+ :type parent: declaration_t
+ :param values: Enumeration values
+ :type values: list
"""
declaration.declaration_t.__init__( self, name )
@@ -83,10 +83,10 @@
When the 'values' attribute is accessed the resulting list will be in the same
order as append_value() was called.
- @param valuename: The name of the value.
- @type valuename: str
- @param valuenum: The numeric value or None.
- @type valuenum: int
+ :param valuename: The name of the value.
+ :type valuename: str
+ :param valuenum: The numeric value or None.
+ :type valuenum: int
"""
# No number given? Then use the previous one + 1
if valuenum==None:
@@ -101,9 +101,9 @@
def has_value_name(self, name):
"""Check if this enum has a particular name among its values.
- @param name: Enumeration value name
- @type name: str
- @return: True if there is an enumeration value with the given name
+ :param name: Enumeration value name
+ :type name: str
+ :rtype: True if there is an enumeration value with the given name
"""
for val,num in self._values:
if val==name:
Modified: pygccxml_dev/pygccxml/declarations/matcher.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/matcher.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/matcher.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -34,9 +34,9 @@
def find( decl_matcher, decls, recursive=True ):
"""returns a list of declarations that match "decl_matcher" defined criretia or None
- @param decl_matcher: Python callable object, that takes one argument - reference to declaration
- @param decls: reference to declaration or list of declarations to be searched in
- @param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
+ :param decl_matcher: Python callable object, that takes one argument - reference to declaration
+ :param decls: reference to declaration or list of declarations to be searched in
+ :param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
"""
where = []
@@ -54,9 +54,9 @@
criretia, 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 declaration
- @param decls: reference to declaration or list of declarations to be searched in
- @param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
+ :param decl_matcher: Python callable object, that takes one argument - reference to declaration
+ :param decls: reference to declaration or list of declarations to be searched in
+ :param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
"""
answer = matcher.find( decl_matcher, decls, recursive )
if len(answer) == 1:
@@ -68,9 +68,9 @@
criretia, 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 declaration
- @param decls: reference to declaration or list of declarations to be searched in
- @param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
+ :param decl_matcher: Python callable object, that takes one argument - reference to declaration
+ :param decls: reference to declaration or list of declarations to be searched in
+ :param recursive: boolean, if True the method will run decl_matcher, on internal declarations too
"""
answer = matcher.find( decl_matcher, decls, recursive )
if len(answer) == 1:
Modified: pygccxml_dev/pygccxml/declarations/matchers.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/matchers.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/matchers.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -117,17 +117,17 @@
"""
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}.
- @type decl_type: any class that derives from L{declarations.declaration_t} class
+ :param decl_type: declaration type to match by. For example L{enumeration_t}.
+ :type decl_type: any class that derives from L{declarations.declaration_t} class
- @param name: declaration name, could be full name.
- @type name: str
+ :param name: declaration name, could be full name.
+ :type name: str
- @param header_dir: absolute directory path
- @type header_dir: str
+ :param header_dir: absolute directory path
+ :type header_dir: str
- @param header_file: absolute file path
- @type header_file: str
+ :param header_file: absolute file path
+ :type header_file: str
"""
#An other option is that pygccxml will create absolute path using
@@ -264,8 +264,8 @@
"""
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
+ :param type: variable type
+ :type type: string or instance of L{type_t} derived class
"""
declaration_matcher_t.__init__( self
, name=name
@@ -322,10 +322,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
+ :param return_type: callable return type
+ :type return_type: string or instance of L{type_t} derived class
- @param arg_types: list of function argument types. arg_types can contain.
+ :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
class. If you don't want some argument to participate in match you can
put None. For example:
@@ -334,7 +334,7 @@
will match all functions that takes 2 arguments, where the first one is
reference to integer and second any
- @type arg_types: list
+ :type arg_types: list
"""
if None is decl_type:
decl_type = calldef.calldef_t
@@ -402,8 +402,8 @@
"""
def __init__( self, name=None, symbol=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None):
"""
- @param symbol: operator symbol
- @type symbol: str
+ :param symbol: operator symbol
+ :type symbol: str
"""
if None is decl_type:
decl_type = calldef.operator_t
@@ -443,10 +443,10 @@
"""
def __init__( self, regex, function=None ):
"""
- @param regex: regular expression
- @type regex: string, an instance of this class will compile it for you
+ :param regex: regular expression
+ :type regex: string, an instance of this class will compile it for you
- @param function: function that will be called to get an information from
+ :param function: function that will be called to get an information from
declaration as string. As input this function takes 1 argument: reference
to declaration. Return value should be string. If function is None, then
the matcher will use declaration name.
@@ -474,8 +474,8 @@
def __init__( self, access_type ):
"""
- @param access_type: declaration access type
- @type access_type: L{ACCESS_TYPES} defines few consts for your convinience.
+ :param access_type: declaration access type
+ :type access_type: L{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 )
@@ -498,8 +498,8 @@
def __init__( self, virtuality_type ):
"""
- @param access_type: declaration access type
- @type access_type: L{VIRTUALITY_TYPES} defines few consts for your convinience.
+ :param access_type: declaration access type
+ :type access_type: L{VIRTUALITY_TYPES} defines few consts for your convinience.
"""
matcher_base_t.__init__( self )
self.virtuality_type = virtuality_type
@@ -520,7 +520,7 @@
def __init__( self, function ):
"""
- @param function: callable, that takes single argument - declaration instance
+ :param function: callable, that takes single argument - declaration instance
should return True or False
"""
matcher_base_t.__init__( self )
Modified: pygccxml_dev/pygccxml/declarations/mdecl_wrapper.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/mdecl_wrapper.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/mdecl_wrapper.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -17,8 +17,8 @@
def __init__( self, name, decls ):
"""creates call_redirector_t instance.
- @param name: name of method, to be called on every object in C{decls} list
- @param decls: list of objects
+ :param name: name of method, to be called on every object in C{decls} list
+ :param decls: list of objects
"""
object.__init__( self )
self.name = name
@@ -45,8 +45,8 @@
"""
def __init__( self, decls ):
- """@param decls: list of declarations to operate on.
- @type decls: list of L{declaration wrappers<decl_wrapper_t>}
+ """:param decls: list of declarations to operate on.
+ :type decls: list of L{declaration wrappers<decl_wrapper_t>}
"""
object.__init__( self )
self.__dict__['declarations'] = decls
@@ -74,15 +74,15 @@
def __setattr__( self, name, value ):
"""Updates the value of attribute on all declarations.
- @param name: name of attribute
- @param value: new value of attribute
+ :param name: name of attribute
+ :param value: new value of attribute
"""
self.__ensure_attribute( name )
for d in self.declarations:
setattr( d, name, value )
def __getattr__( self, name ):
- """@param name: name of method
+ """:param name: name of method
"""
return call_redirector_t( name, self.declarations )
Modified: pygccxml_dev/pygccxml/declarations/namespace.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/namespace.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/namespace.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -57,8 +57,8 @@
"""
removes decl from members list
- @param decl: declaration to be removed
- @type decl: L{declaration_t}
+ :param decl: declaration to be removed
+ :type decl: L{declaration_t}
"""
del self.declarations[ self.declarations.index( decl ) ]
decl.cache.reset()
Modified: pygccxml_dev/pygccxml/declarations/scopedef.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/scopedef.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/scopedef.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -652,7 +652,7 @@
def __getitem__(self, name_or_function):
""" Allow simple name based find of decls. Internally just calls decls() method.
- @param name_or_function Name of decl to lookup or finder function.
+ :param name_or_function Name of decl to lookup or finder function.
"""
return self.decls(name_or_function)
Modified: pygccxml_dev/pygccxml/declarations/templates.py
===================================================================
--- pygccxml_dev/pygccxml/declarations/templates.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/declarations/templates.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -23,10 +23,10 @@
"""
returns True if decl_string is template instantiation and False otherwise
- @param decl_string: string that should be checked for pattern presence
- @type decl_string: str
+ :param decl_string: string that should be checked for pattern presence
+ :type decl_string: str
- @return: bool
+ :rtype: bool
"""
global __THE_PARSER
return __THE_PARSER.has_pattern( decl_string )
@@ -35,8 +35,8 @@
"""
returns name of instantiated template
- @type decl_string: str
- @return: str
+ :type decl_string: str
+ :rtype: str
"""
global __THE_PARSER
return __THE_PARSER.name( decl_string )
@@ -45,8 +45,8 @@
"""
returns list of template arguments
- @type decl_string: str
- @return: [str]
+ :type decl_string: str
+ :rtype: [str]
"""
global __THE_PARSER
return __THE_PARSER.args( decl_string )
Modified: pygccxml_dev/pygccxml/parser/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/parser/__init__.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/parser/__init__.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -37,14 +37,14 @@
"""
Parse header files.
- @param files: The header files that should be parsed
- @type files: list of str
- @param config: Configuration object or None
- @type config: L{config_t}
- @param compilation_mode: Determines whether the files are parsed individually or as one single chunk
- @type compilation_mode: L{COMPILATION_MODE}
- @param cache: Declaration cache (None=no cache)
- @type cache: L{cache_base_t} or str
+ :param files: The header files that should be parsed
+ :type files: list of str
+ :param config: Configuration object or None
+ :type config: L{config_t}
+ :param compilation_mode: Determines whether the files are parsed individually or as one single chunk
+ :type compilation_mode: L{COMPILATION_MODE}
+ :param cache: Declaration cache (None=no cache)
+ :type cache: L{cache_base_t} or str
@returns: Declarations
"""
if not config:
Modified: pygccxml_dev/pygccxml/parser/declarations_cache.py
===================================================================
--- pygccxml_dev/pygccxml/parser/declarations_cache.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/parser/declarations_cache.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -58,19 +58,19 @@
def update(self, source_file, configuration, declarations, included_files):
""" Update cache entry.
- @param source_file: path to the C++ source file being parsed
- @param configuration: configuration used in parsing (config_t)
- @param declarations: declaration tree found when parsing
- @param included_files: files included by parsing.
+ :param source_file: path to the C++ source file being parsed
+ :param configuration: configuration used in parsing (config_t)
+ :param declarations: declaration tree found when parsing
+ :param included_files: files included by parsing.
"""
raise NotImplementedError()
def cached_value(self, source_file, configuration):
- """ Return declarations we have cached for the source_file and configuration
- given.
- @param source_file: path to the C++ source file being parsed.
- @param configuration: configuration to use for parsing (config_t)
"""
+ Return declarations, we have cached, for the source_file and the given configuration.
+ :param source_file: path to the C++ source file being parsed.
+ :param configuration: configuration to use for parsing (config_t)
+ """
raise NotImplementedError()
class record_t( object ):
@@ -131,7 +131,7 @@
def __init__( self, name ):
"""
- @param name: name of the cache file.
+ :param name: name of the cache file.
"""
cache_base_t.__init__( self )
self.__name = name # Name of cache file
Modified: pygccxml_dev/pygccxml/parser/directory_cache.py
===================================================================
--- pygccxml_dev/pygccxml/parser/directory_cache.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/parser/directory_cache.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -109,14 +109,14 @@
def update(self, source_file, configuration, declarations, included_files):
"""Replace a cache entry by a new value.
- @param source_file: Header file name.
- @type source_file: str
- @param configuration: Configuration object.
- @type configuration: L{config_t}
- @param declarations: Declarations contained in the header file.
- @type declarations: picklable object
- @param included_files: Dependent files
- @type included_files: list of str
+ :param source_file: Header file name.
+ :type source_file: str
+ :param configuration: Configuration object.
+ :type configuration: L{config_t}
+ :param declarations: Declarations contained in the header file.
+ :type declarations: picklable object
+ :param included_files: Dependent files
+ :type included_files: list of str
"""
# Normlize all paths...
source_file = os.path.normpath(source_file)
@@ -156,11 +156,11 @@
def cached_value(self, source_file, configuration):
"""Return the cached declarations or None.
- @param source_file: Header file name
- @type source_file: str
- @param configuration: Configuration object
- @type configuration: L{config_t}
- @return: Cached declarations or None
+ :param source_file: Header file name
+ :type source_file: str
+ :param configuration: Configuration object
+ :type configuration: L{config_t}
+ :rtype: Cached declarations or None
"""
# Check if the cache contains an entry for source_file
@@ -240,8 +240,8 @@
Reads a pickled object from disk and returns it.
- @param filename: Name of the file that should be read.
- @type filename: str
+ :param filename: Name of the file that should be read.
+ :type filename: str
@returns: Unpickled file contents
"""
if self.__compression:
@@ -257,10 +257,10 @@
The data object is written to a file using the pickle mechanism.
- @param filename: Output file name
- @type filename: str
- @param data: A Python object that will be pickled
- @type data: picklable object
+ :param filename: Output file name
+ :type filename: str
+ :param data: A Python object that will be pickled
+ :type data: picklable object
"""
if self.__compression:
f = gzip.GzipFile(filename, "wb")
@@ -280,10 +280,10 @@
If key references a non-existing entry, the method returns
immediately.
- @param source_file: Header file name
- @type source_file: str
- @param key: Key value for the specified header file
- @type key: hashable object
+ :param source_file: Header file name
+ :type source_file: str
+ :param key: Key value for the specified header file
+ :type key: hashable object
"""
entry = self.__index.get(key)
@@ -309,8 +309,8 @@
def _create_cache_key(self, source_file):
"""Return the cache key for a header file.
- @param source_file: Header file name
- @type source_file: str
+ :param source_file: Header file name
+ :type source_file: str
@returns: Key for the given header file
@rtype: str
"""
@@ -320,8 +320,8 @@
def _create_cache_filename(self, source_file):
"""Return the cache file name for a header file.
- @param source_file: Header file name
- @type source_file: str
+ :param source_file: Header file name
+ :type source_file: str
@returns: Cache file name (*.cache)
@rtype: str
"""
@@ -335,8 +335,8 @@
working_directory, include_paths, define_symbols and
undefine_symbols.
- @param config: Configuration object
- @type config: L{config_t}
+ :param config: Configuration object
+ :type config: L{config_t}
@returns: Signature
@rtype: str
"""
Modified: pygccxml_dev/pygccxml/parser/project_reader.py
===================================================================
--- pygccxml_dev/pygccxml/parser/project_reader.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/parser/project_reader.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -92,10 +92,10 @@
Creates L{file_configuration_t} instance, configured to contain Python string,
that contains valid C++ code
- @param text: C++ code
- @type text: str
+ :param text: C++ code
+ :type text: str
- @return: L{file_configuration_t}
+ :rtype: L{file_configuration_t}
"""
return file_configuration_t( data=text
, content_type=file_configuration_t.CONTENT_TYPE.TEXT )
@@ -105,10 +105,10 @@
Creates L{file_configuration_t} instance, configured to contain path to
C++ source file
- @param header: path to C++ source file
- @type header: str
+ :param header: path to C++ source file
+ :type header: str
- @return: L{file_configuration_t}
+ :rtype: L{file_configuration_t}
"""
return file_configuration_t( data=header
, content_type=file_configuration_t.CONTENT_TYPE.STANDARD_SOURCE_FILE )
@@ -118,10 +118,10 @@
Creates L{file_configuration_t} instance, configured to contain path to
GCC-XML generated XML file.
- @param xml_file: path to GCC-XML generated XML file
- @type xml_file: str
+ :param xml_file: path to GCC-XML generated XML file
+ :type xml_file: str
- @return: L{file_configuration_t}
+ :rtype: L{file_configuration_t}
"""
return file_configuration_t( data=xml_file
, content_type=file_configuration_t.CONTENT_TYPE.GCCXML_GENERATED_FILE )
@@ -133,13 +133,13 @@
it will be created and used for parsing. If XML file exists, it will be used
for parsing.
- @param header: path to C++ source file
- @type header: str
+ :param header: path to C++ source file
+ :type header: str
- @param cached_source_file: path to GCC-XML generated XML file
- @type cached_source_file: str
+ :param cached_source_file: path to GCC-XML generated XML file
+ :type cached_source_file: str
- @return: L{file_configuration_t}
+ :rtype: L{file_configuration_t}
"""
return file_configuration_t( data=header
, cached_source_file=cached_source_file
@@ -161,12 +161,12 @@
appropriate declaration class. By default, the declaration
classes defined in the L{declarations} package are used.
- @param config: Configuration object
- @type config: L{config_t}
- @param cache: Declaration cache (None=no cache)
- @type cache: L{cache_base_t} or str
- @param decl_factory: Custom declaration factory object or None
- @type decl_factory: decl_factory_t
+ :param config: Configuration object
+ :type config: L{config_t}
+ :param cache: Declaration cache (None=no cache)
+ :type cache: L{cache_base_t} or str
+ :param decl_factory: Custom declaration factory object or None
+ :type decl_factory: decl_factory_t
"""
self.__config = config
self.__dcache = None
@@ -186,9 +186,9 @@
def get_os_file_names( files ):
"""Returns a list of OS file names
- @param files: list of strings or L{file_configuration_t} instances.
+ :param files: list of strings or L{file_configuration_t} instances.
files could contain a mix of them
- @type files: list
+ :type files: list
"""
fnames = []
for f in files:
@@ -205,11 +205,11 @@
def read_files( self, files, compilation_mode=COMPILATION_MODE.FILE_BY_FILE):
"""Parse header files.
- @param files: list of strings or L{file_configuration_t} instances.
+ :param files: list of strings or L{file_configuration_t} instances.
files could contain a mix of them
- @type files: list
- @param compilation_mode: Determines whether the files are parsed individually or as one single chunk
- @type compilation_mode: L{COMPILATION_MODE}
+ :type files: list
+ :param compilation_mode: Determines whether the files are parsed individually or as one single chunk
+ :type compilation_mode: L{COMPILATION_MODE}
@returns: Declarations
"""
if compilation_mode == COMPILATION_MODE.ALL_AT_ONCE \
@@ -300,8 +300,8 @@
def read_string(self, content):
"""Parse a string containing C/C++ source code.
- @param content: C/C++ source code.
- @type content: str
+ :param content: C/C++ source code.
+ :type content: str
@returns: Declarations
"""
reader = source_reader.source_reader_t( self.__config, None, self.__decl_factory )
Modified: pygccxml_dev/pygccxml/parser/source_reader.py
===================================================================
--- pygccxml_dev/pygccxml/parser/source_reader.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/pygccxml/parser/source_reader.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -27,10 +27,10 @@
"""
This function binds between class and it's typedefs.
- @param decls: list of all declarations
- @type all_classes: list of L{declaration_t} items
+ :param decls: list of all declarations
+ :type all_classes: list of L{declaration_t} items
- @return: None
+ :rtype: None
"""
visited = set()
typedefs = filter( lambda decl: isinstance( decl, typedef_t ), decls )
@@ -65,15 +65,15 @@
"""
def __init__( self, config, cache=None, decl_factory=None ):
"""
- @param config: instance of L{config_t} class, that contains GCC-XML
+ :param config: instance of L{config_t} class, that contains GCC-XML
configuration
- @type config: L{config_t}
+ :type config: L{config_t}
- @param cache: reference to cache object, that will be updated after
+ :param cache: reference to cache object, that will be updated after
file has been parsed.
- @param cache: instance of class, that derives from {cache_base_t}
+ :param cache: instance of class, that derives from {cache_base_t}
- @param decl_factory: declarations factory, if not given default
+ :param decl_factory: declarations factory, if not given default
declarations factory L{decl_factory_t} will be used
"""
self.logger = utils.loggers.cxx_parser
@@ -128,14 +128,14 @@
for "header" file. If destination_file_path is not None, then this file
path will be used and returned.
- @param header: path to source file, that should be parsed
- @type header: str
+ :param header: path to source file, that should be parsed
+ :type header: str
- @param destination: if given, will be used as target file/path for
+ :param destination: if given, will be used as target file/path for
GCC-XML generated file.
- @type destination: str
+ :type destination: str
- @return: path to GCC-XML generated file
+ :rtype: path to GCC-XML generated file
"""
gccxml_file = destination
# If file specified, remove it to start else create new file name
@@ -173,13 +173,13 @@
"""
Creates XML file from text.
- @param content: C++ source code
- @type content: str
+ :param content: C++ source code
+ :type content: str
- @param destination: file name for GCC-XML generated file
- @type destination: str
+ :param destination: file name for GCC-XML generated file
+ :type destination: str
- @return: returns file name of GCC-XML generated file
+ :rtype: returns file name of GCC-XML generated file
"""
header_file = pygccxml.utils.create_temp_file_name( suffix='.h' )
gccxml_file = None
@@ -199,8 +199,8 @@
"""
Reads C++ source file and returns declarations tree
- @param source_file: path to C++ source file
- @type source_file: str
+ :param source_file: path to C++ source file
+ :type source_file: str
"""
declarations = None
gccxml_file = ''
@@ -227,10 +227,10 @@
"""
Reads GCC-XML generated XML file.
- @param gccxml_created_file: path to GCC-XML generated file
- @type gccxml_created_file: str
+ :param gccxml_created_file: path to GCC-XML generated file
+ :type gccxml_created_file: str
- @return: declarations tree
+ :rtype: declarations tree
"""
assert(self.__config!=None)
Modified: pygccxml_dev/unittests/data/core_cache.hpp
===================================================================
--- pygccxml_dev/unittests/data/core_cache.hpp 2009-02-02 13:53:17 UTC (rev 1649)
+++ pygccxml_dev/unittests/data/core_cache.hpp 2009-02-02 18:31:43 UTC (rev 1650)
@@ -22,4 +22,4 @@
#endif//__core_cache_hpp__
-//touch//touch//touch//touch//touch//touch//touch//touch//touch
\ No newline at end of file
+//touch//touch//touch//touch//touch//touch//touch//touch//touch//touch
\ No newline at end of file
Modified: pyplusplus_dev/pyplusplus/code_creators/calldef_transformed.py
===================================================================
--- pyplusplus_dev/pyplusplus/code_creators/calldef_transformed.py 2009-02-02 13:53:17 UTC (rev 1649)
+++ pyplusplus_dev/pyplusplus/code_creators/calldef_transformed.py 2009-02-02 18:31:43 UTC (rev 1650)
@@ -137,8 +137,8 @@
def __init__( self, function ):
"""Constructor.
- @param function: Function declaration
- @type function: calldef_t
+ :param function: Function declaration
+ :type function: calldef_t
"""
sealed_fun_transformed_wrapper_t .__init__( self, function=function )
@@ -193,8 +193,8 @@
def __init__( self, function ):
"""Constructor.
- @param function: Function declaration
- @type function: calldef_t
+ :param function: Function declaration...
[truncated message content] |
