[pygccxml-commit] SF.net SVN: pygccxml:[1669] pygccxml_dev
Brought to you by:
mbaas,
roman_yakovenko
Menu
▾
▴
[pygccxml-commit] SF.net SVN: pygccxml:[1669] pygccxml_dev
|
From: <rom...@us...> - 2009-02-09 21:10:13
|
Revision: 1669
http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1669&view=rev
Author: roman_yakovenko
Date: 2009-02-09 21:10:08 +0000 (Mon, 09 Feb 2009)
Log Message:
-----------
sphinx
Modified Paths:
--------------
index.rest
pydsc_dev/docs/pydsc.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/docs/pygccxml.rest
pygccxml_dev/pygccxml/binary_parsers/__init__.py
pygccxml_dev/pygccxml/binary_parsers/parsers.py
pygccxml_dev/pygccxml/utils/__init__.py
Modified: index.rest
===================================================================
--- index.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ index.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -10,10 +10,8 @@
* Do you need to build code generator?
* Do you need to create UML diagram?
-`pygccxml`_ is the way to go! `Learn more`__.
+:doc:`pygccxml <pygccxml/pygccxml>` is the way to go! :doc:`Learn more <pygccxml/pygccxml>`.
-.. __: `pygccxml`_
-
------------
Py++ package
------------
@@ -21,79 +19,36 @@
"I love deadlines. I love the whooshing noise they make as they go by."
-- Douglas Adams
-Meet your deadlines with powerful code generator engine - `Py++`_.
-`Py++`_ package and `Boost.Python`_ library provide a complete solution for
-interfacing Python and C++. `Learn more`_.
+Meet your deadlines with powerful code generator engine - :doc:`Py++ <pyplusplus/pyplusplus>`.
-*European Space Agency*, *Ogre*, *PyOpenSG* and many others `use`__ Py++.
+:doc:`Py++ <pyplusplus/pyplusplus>`, `ctypes <http://docs.python.org/library/ctypes.html>`_
+and `Boost.Python <http://www.boost.org/doc/libs/1_38_0/libs/python/doc/index.html>`_
+provide a complete solution for interfacing Python and C\\C++.
+:doc:`Learn more <pyplusplus/pyplusplus>`.
-.. _`Learn more` : `Py++`_
+*European Space Agency*, *Ogre*, *PyOpenSG* and many others :doc:`use <pyplusplus/quotes>` `Py++`.
-.. __: ./pyplusplus/quotes.html
-
----------------
-pyboost package
----------------
-
-`Boost`_ provides free peer-reviewed portable C++ source libraries. `pyboost`_
-package export the following libraries to Python:
-
- * `Boost.Date_Time`_ - date time library designed to provide a basis for
- performing efficient time calculations
- * `Boost.CRC`_ - cyclic redundancy code computation objects
- * `Boost.Rational`_ - rational number class
- * `Boost.Random`_ - a complete system for random number generation
-
-Python bindings for `boost.graph`_ library is also available from
-http://www.osl.iu.edu/~dgregor/bgl-python .
-
-------------
pydsc package
-------------
-Documentation strings contain spelling errors? `Fix them in a minute`_.
+Documentation strings contain spelling errors? :doc:`Fix them in a minute <pydsc/pydsc>`!
-.. _`Fix them in a minute` : `pydsc`_
+-------------
+Documentation
+-------------
------------------
-pyeasybmp package
------------------
-
-`EasyBMP`_ could be easier? Yes of course! Learn more about `EasyBMP Python bindings`_.
-
-.. _`EasyBMP Python bindings`: ./pyplusplus/examples/easybmp/easybmp.html
-
-
-.. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
.. toctree::
:maxdepth: 2
- pydsc/pydsc.rest
pygccxml/pygccxml.rest
pyplusplus/pyplusplus.rest
+ pydsc/pydsc.rest
+------------------
+Indices and tables
+------------------
-.. _`pyboost` : ./pyplusplus/examples/boost/boost.html
-.. _`boost.graph` : http://www.boost.org/libs/graph/doc/table_of_contents.html
-.. _`boost.date_time` : http://boost.org/doc/html/date_time.html
-.. _`boost.crc` : http://boost.org/libs/crc/index.html
-.. _`boost.rational` : http://boost.org/libs/rational/index.html
-.. _`boost.random` : http://boost.org/libs/random/index.html
-
-.. _`Boost`: http://boost.org/
-.. _`Python`: http://www.python.org
-.. _`pygccxml`: ./pygccxml/pygccxml.html
-.. _`Py++`: ./pyplusplus/pyplusplus.html
-.. _`pydsc`: ./pydsc/pydsc.html
-.. _`EasyBMP`: http://easybmp.sourceforge.net/
-
-.. _`many others` : ./x.html
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
Modified: pydsc_dev/docs/pydsc.rest
===================================================================
--- pydsc_dev/docs/pydsc.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pydsc_dev/docs/pydsc.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -1,14 +1,7 @@
-==================
+==================
pydsc introduction
==================
-.. contents:: Table of contents
-
-.. toctree::
- :maxdepth: 1
-
- API <api>
-
.. meta::
:description: Python documentation string spell checker
:keywords: Python, docstring, documentation, spell, check
@@ -69,5 +62,14 @@
python setup.py install
+---
+API
+---
+.. toctree::
+ :maxdepth: 1
+
+ API <api>
+
+
.. _`PyEnchant`: http://pyenchant.sourceforge.net/
Modified: pygccxml_dev/docs/apidocs/binary_parsers.rest
===================================================================
--- pygccxml_dev/docs/apidocs/binary_parsers.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/docs/apidocs/binary_parsers.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -2,9 +2,16 @@
pygccxml.binary_parsers API
===========================
-parsers
--------
+binary_parsers package
+----------------------
+.. automodule:: pygccxml.binary_parsers
+ :members:
+ :show-inheritance:
+
+parsers module
+--------------
+
.. automodule:: pygccxml.binary_parsers.parsers
:members:
:show-inheritance:
Modified: pygccxml_dev/docs/apidocs/declarations.rest
===================================================================
--- pygccxml_dev/docs/apidocs/declarations.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/docs/apidocs/declarations.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -2,176 +2,184 @@
pygccxml.declarations package
=============================
-algorithm
----------
+declarations package
+--------------------
-.. automodule:: pygccxml.declarations.algorithm
+.. automodule:: pygccxml.declarations
:members:
:show-inheritance:
-algorithms_cache
+
+algorithm module
----------------
+.. automodule:: pygccxml.declarations.algorithm
+ :members:
+ :show-inheritance:
+
+algorithms_cache module
+-------------------------
+
.. automodule:: pygccxml.declarations.algorithms_cache
:members:
:show-inheritance:
-calldef
--------
+calldef module
+----------------
.. automodule:: pygccxml.declarations.calldef
:members:
:show-inheritance:
-call_invocation
----------------
+call_invocation module
+------------------------
.. automodule:: pygccxml.declarations.call_invocation
:members:
:show-inheritance:
-class_declaration
------------------
+class_declaration module
+--------------------------
.. automodule:: pygccxml.declarations.class_declaration
:members:
:show-inheritance:
-compilers
----------
+compilers module
+------------------
.. automodule:: pygccxml.declarations.compilers
:members:
:show-inheritance:
-container_traits
-----------------
+container_traits module
+-------------------------
.. automodule:: pygccxml.declarations.container_traits
:members:
:show-inheritance:
-cpptypes
---------
+cpptypes module
+-----------------
.. automodule:: pygccxml.declarations.cpptypes
:members:
:show-inheritance:
-declaration
------------
+declaration module
+--------------------
.. automodule:: pygccxml.declarations.declaration
:members:
:show-inheritance:
-decl_factory
-------------
+decl_factory module
+---------------------
.. automodule:: pygccxml.declarations.decl_factory
:members:
:show-inheritance:
-decl_printer
-------------
+decl_printer module
+---------------------
.. automodule:: pygccxml.declarations.decl_printer
:members:
:show-inheritance:
-decl_visitor
-------------
+decl_visitor module
+---------------------
.. automodule:: pygccxml.declarations.decl_visitor
:members:
:show-inheritance:
-dependencies
-------------
+dependencies module
+---------------------
.. automodule:: pygccxml.declarations.dependencies
:members:
:show-inheritance:
-enumeration
------------
+enumeration module
+--------------------
.. automodule:: pygccxml.declarations.enumeration
:members:
:show-inheritance:
-function_traits
----------------
+function_traits module
+------------------------
.. automodule:: pygccxml.declarations.function_traits
:members:
:show-inheritance:
-matcher
--------
+matcher module
+----------------
.. automodule:: pygccxml.declarations.matcher
:members:
:show-inheritance:
-matchers
---------
+matchers module
+-----------------
.. automodule:: pygccxml.declarations.matchers
:members:
:show-inheritance:
-mdecl_wrapper
--------------
+mdecl_wrapper module
+----------------------
.. automodule:: pygccxml.declarations.mdecl_wrapper
:members:
:show-inheritance:
-namespace
----------
+namespace module
+------------------
.. automodule:: pygccxml.declarations.namespace
:members:
:show-inheritance:
-scopedef
---------
+scopedef module
+-----------------
.. automodule:: pygccxml.declarations.scopedef
:members:
:show-inheritance:
-templates
----------
+templates module
+------------------
.. automodule:: pygccxml.declarations.templates
:members:
:show-inheritance:
-typedef
--------
+typedef module
+----------------
.. automodule:: pygccxml.declarations.typedef
:members:
:show-inheritance:
-type_traits
------------
+type_traits module
+--------------------
.. automodule:: pygccxml.declarations.type_traits
:members:
:show-inheritance:
-type_visitor
-------------
+type_visitor module
+---------------------
.. automodule:: pygccxml.declarations.type_visitor
:members:
:show-inheritance:
-variable
---------
+variable module
+---------------
.. automodule:: pygccxml.declarations.variable
:members:
Modified: pygccxml_dev/docs/apidocs/parser.rest
===================================================================
--- pygccxml_dev/docs/apidocs/parser.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/docs/apidocs/parser.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -2,44 +2,51 @@
pygccxml.parser package
=======================
-config
-------
+parser package
+--------------
+.. automodule:: pygccxml.parser
+ :members:
+ :show-inheritance:
+
+config module
+---------------
+
.. automodule:: pygccxml.parser.config
:members:
:show-inheritance:
-declarations_cache
-------------------
+declarations_cache module
+----------------------------
.. automodule:: pygccxml.parser.declarations_cache
:members:
:show-inheritance:
-directory_cache
----------------
+directory_cache module
+------------------------
.. automodule:: pygccxml.parser.directory_cache
:members:
:show-inheritance:
-patcher
--------
+patcher module
+----------------
.. automodule:: pygccxml.parser.patcher
:members:
:show-inheritance:
-project_reader
---------------
+project_reader module
+---------------------
.. automodule:: pygccxml.parser.project_reader
:members:
:show-inheritance:
-source_reader
--------------
+source_reader module
+----------------------
.. automodule:: pygccxml.parser.source_reader
:members:
Modified: pygccxml_dev/docs/apidocs/utils.rest
===================================================================
--- pygccxml_dev/docs/apidocs/utils.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/docs/apidocs/utils.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -2,10 +2,17 @@
pygccxml.utils package
======================
+utils package
+-------------
-fs_utils
---------
+.. automodule:: pygccxml.utils
+ :members:
+ :show-inheritance:
+
+fs_utils module
+---------------
+
.. automodule:: pygccxml.utils.fs_utils
:members:
:show-inheritance:
Modified: pygccxml_dev/docs/pygccxml.rest
===================================================================
--- pygccxml_dev/docs/pygccxml.rest 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/docs/pygccxml.rest 2009-02-09 21:10:08 UTC (rev 1669)
@@ -1,4 +1,4 @@
-======================
+======================
pygccxml documentation
======================
@@ -17,12 +17,12 @@
------------------------
What can you do with it?
------------------------
-Using :doc:`pygccxml <pygccxml>` you can:
+Using `pygccxml` you can:
* parse C++ source code
* create a powerful code generator
- + :doc:`Py++ <../pyplusplus/pyplusplus>` is heavily based on :doc:`pygccxml <pygccxml>`
+ + :doc:`Py++ <../pyplusplus/pyplusplus>` is heavily based on `pygccxml`
+ generate `WSDL`_ file from sources
+ ...
@@ -36,8 +36,9 @@
Query interface
---------------
-:doc:`pygccxml <pygccxml>` provides simple and powerful API to query declarations tree. How many
-lines is needed to write the following query?
+`pygccxml` provides simple and powerful API to query declarations tree.
+
+How many lines is needed to write the following query?
::
select all free functions from the project
@@ -47,7 +48,7 @@
function has two arguments
second argument type is int
-Only 1 ( one ) line of code is needed:
+Only single line of code is needed:
.. code-block:: python
@@ -61,7 +62,7 @@
Type traits
-----------
-:doc:`pygccxml <pygccxml>` provides a lot of functionality to analyze C++ types and relationship
+`pygccxml` provides a lot of functionality to analyze C++ types and relationship
between them. For more information please refer to :doc:`design <design>` document or API
documentation. Just a few names of algorithms:
@@ -92,7 +93,7 @@
* parse each file separately and then join the results
The difference between these approaches is the caching algorithm used in the
-second case. :doc:`pygccxml <pygccxml>` supports both of them. Actually :doc:`pygccxml <pygccxml>` supports
+second case. `pygccxml` supports both of them. Actually `pygccxml` supports
more caching strategies, read the API documentation for more information.
@@ -106,7 +107,7 @@
Test environment
----------------
-:doc:`pygccxml <pygccxml>` comes with comprehensive unit tests. They are executed on Windows XP
+`pygccxml` comes with comprehensive unit tests. They are executed on Windows XP
and `Ubuntu`_ Linux operating systems. In most cases Python 2.5 and 2.6 are used.
All in all, `pygccxml` has more than 230 tests.
@@ -119,9 +120,9 @@
.. toctree::
example/example.rest
+ query_interface.rest
download.rest
design.rest
- query_interface.rest
upgrade_issues.rest
users.rest
links.rest
Modified: pygccxml_dev/pygccxml/binary_parsers/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/binary_parsers/__init__.py 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/pygccxml/binary_parsers/__init__.py 2009-02-09 21:10:08 UTC (rev 1669)
@@ -5,9 +5,9 @@
"""
contains classes that allows to extract different information from binary files
-( .pdb, .map, .dll, .bsc, .so ) and integrate it with existing declarations tree
+( .map, .dll, .so ) and integrate it with existing declarations tree
-The main function of this package is "merge_information"
+The main function of this package is :func:`pygccxml.binary_parsers.parsers.merge_information`.
"""
import undname
@@ -18,7 +18,8 @@
return undname.undname_creator_t().undecorate_blob( blob )
def format_decl( decl, hint=None ):
- """returns string, that represents formatted declaration, according to some rules
- hint valid values are: "msvc" and "nm"
"""
+ returns string, that represents formatted declaration, according to some rules
+ :param hint: valid values are: "msvc" and "nm"
+ """
return undname.undname_creator_t().format_decl( decl, hint=hint )
Modified: pygccxml_dev/pygccxml/binary_parsers/parsers.py
===================================================================
--- pygccxml_dev/pygccxml/binary_parsers/parsers.py 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/pygccxml/binary_parsers/parsers.py 2009-02-09 21:10:08 UTC (rev 1669)
@@ -9,8 +9,10 @@
Those classes extract decorated\mangled names from the files. Later the extracted
symbols are used for:
-* building "dynamic library" public interface
-* extracting function calling convention
+
+ * building "dynamic library" public interface
+ * extracting function calling convention
+
"""
import os
Modified: pygccxml_dev/pygccxml/utils/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/utils/__init__.py 2009-02-09 19:09:47 UTC (rev 1668)
+++ pygccxml_dev/pygccxml/utils/__init__.py 2009-02-09 21:10:08 UTC (rev 1669)
@@ -4,8 +4,7 @@
# http://www.boost.org/LICENSE_1_0.txt)
"""
-defines logger classes and few convenience methods, not related to the declarations
-tree
+defines logger classes and few convenience methods, not related to the declarations tree
"""
import os
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
