[pygccxml-commit] SF.net SVN: pygccxml:[1641] pygccxml_dev

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 1641
          http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1641&view=rev
Author:   roman_yakovenko
Date:     2009-01-29 22:14:51 +0000 (Thu, 29 Jan 2009)

Log Message:
-----------
sphinx

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/docs/pygccxml.rest
    pygccxml_dev/pygccxml/parser/__init__.py

Removed Paths:
-------------
    pygccxml_dev/docs/apidocs/modules.txt

Modified: pydsc_dev/pydsc.py
===================================================================

--- pydsc_dev/pydsc.py	2009-01-29 19:49:51 UTC (rev 1640)
+++ pydsc_dev/pydsc.py	2009-01-29 22:14:51 UTC (rev 1641)
@@ -65,9 +65,7 @@
     def contains_parent_dir( path, dirs ):
         """
         returns true if one of the directories is root directory for the `path`, false otherwise
-        
-        :parameters:
-            - `path` - a path
+
         @param path: path
         @type path: str
 

Modified: pygccxml_dev/docs/apidocs/api.rest
===================================================================
--- pygccxml_dev/docs/apidocs/api.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/api.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,14 +1,13 @@
-============
-pygccxml API
-============
+===
+API
+===
 
-Modules:
---------
+`pygccxml` consists from 4 sub packages
 
 .. toctree::
    :maxdepth: 4
 
-   binary_parsers
-   declarations
-   parser
-   utils
+   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>

Modified: pygccxml_dev/docs/apidocs/binary_parsers.rest
===================================================================
--- pygccxml_dev/docs/apidocs/binary_parsers.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/binary_parsers.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,11 +1,11 @@
-===========================
-pygccxml.binary_parsers API
-===========================
+===============================
+pygccxml.binary_parsers package
+===============================
 
 This page contains the `pygccxml.binary_parsers` package API documentation.
 
 The :mod:`pygccxml.binary_parsers` package
-------------------------------------------
+-----------------------------------------------------------
 
 .. automodule:: pygccxml.binary_parsers
     :members:
@@ -13,27 +13,11 @@
     :show-inheritance:
 
 
-The :mod:`pygccxml.binary_parsers.get_dll_exported_symbols` module
-------------------------------------------------------------------
+The :mod:`parsers <pygccxml.binary_parsers.parsers>` module
+-----------------------------------------------------------
 
-.. automodule:: pygccxml.binary_parsers.get_dll_exported_symbols
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`pygccxml.binary_parsers.parsers` module
--------------------------------------------------
-
 .. automodule:: pygccxml.binary_parsers.parsers
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`pygccxml.binary_parsers.undname` module
--------------------------------------------------
-
-.. automodule:: pygccxml.binary_parsers.undname
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

Modified: pygccxml_dev/docs/apidocs/declarations.rest
===================================================================
--- pygccxml_dev/docs/apidocs/declarations.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/declarations.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,8 +1,18 @@
-..\Pygccxml_Dev\Pygccxml\Declarations Documentation
-===================================================
+=============================
+pygccxml.declarations package
+=============================
 
-This page contains the ..\Pygccxml_Dev\Pygccxml\Declarations Package documentation.
+This page contains the `pygccxml.declarations` package API documentation.
 
+The :mod:`pygccxml.declarations` package
+----------------------------------------
+
+.. automodule:: pygccxml.declarations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
 The :mod:`pygccxml.declarations.algorithm` module
 -------------------------------------------------
 

Deleted: pygccxml_dev/docs/apidocs/modules.txt
===================================================================
--- pygccxml_dev/docs/apidocs/modules.txt	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/modules.txt	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,16 +0,0 @@
-Miville Modules Documentation
-=============================
-
-This page contains the Miville Modules  documentation.
-
-Modules:
---------
-
-.. toctree::
-   :maxdepth: 4
-
-   __init__
-   binary_parsers
-   declarations
-   parser
-   utils

Modified: pygccxml_dev/docs/apidocs/parser.rest
===================================================================
--- pygccxml_dev/docs/apidocs/parser.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/parser.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,84 +1,85 @@
-..\Pygccxml_Dev\Pygccxml\Parser Documentation
-=============================================
+=======================
+pygccxml.parser package
+=======================
 
-This page contains the ..\Pygccxml_Dev\Pygccxml\Parser Package documentation.
+This page contains the `pygccxml.parser` package API documentation.
 
-The :mod:`parser.config` Modules
---------------------------------
+The :mod:`pygccxml.parser` Package
+----------------------------------------------------------
 
-.. automodule:: parser.config
+.. automodule:: pygccxml.parser
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.declarations_cache` Modules
---------------------------------------------
+The :mod:`pygccxml.parser.config` module
+----------------------------------------
 
-.. automodule:: parser.declarations_cache
+.. automodule:: pygccxml.parser.config
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.directory_cache` Modules
------------------------------------------
+The :mod:`pygccxml.parser.declarations_cache` module
+----------------------------------------------------
 
-.. automodule:: parser.directory_cache
+.. automodule:: pygccxml.parser.declarations_cache
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.etree_scanner` Modules
----------------------------------------
+The :mod:`pygccxml.parser.directory_cache` module
+-------------------------------------------------
 
-.. automodule:: parser.etree_scanner
+.. automodule:: pygccxml.parser.directory_cache
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.linker` Modules
---------------------------------
+The :mod:`pygccxml.parser.etree_scanner` module
+-----------------------------------------------
 
-.. automodule:: parser.linker
+.. automodule:: pygccxml.parser.etree_scanner
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.patcher` Modules
----------------------------------
+The :mod:`pygccxml.parser.linker` module
+----------------------------------------
 
-.. automodule:: parser.patcher
+.. automodule:: pygccxml.parser.linker
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.project_reader` Modules
-----------------------------------------
+The :mod:`pygccxml.parser.patcher` module
+-----------------------------------------
 
-.. automodule:: parser.project_reader
+.. automodule:: pygccxml.parser.patcher
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.scanner` Modules
----------------------------------
+The :mod:`pygccxml.parser.project_reader` module
+------------------------------------------------
 
-.. automodule:: parser.scanner
+.. automodule:: pygccxml.parser.project_reader
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`parser.source_reader` Modules
----------------------------------------
+The :mod:`pygccxml.parser.scanner` module
+-----------------------------------------
 
-.. automodule:: parser.source_reader
+.. automodule:: pygccxml.parser.scanner
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`..\pygccxml_dev\pygccxml\parser` Package
---------------------------------------------------
+The :mod:`pygccxml.parser.source_reader` module
+-----------------------------------------------
 
-.. automodule:: ..\pygccxml_dev\pygccxml\parser
+.. automodule:: pygccxml.parser.source_reader
     :members:
     :undoc-members:
     :show-inheritance:

Modified: pygccxml_dev/docs/apidocs/utils.rest
===================================================================
--- pygccxml_dev/docs/apidocs/utils.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/apidocs/utils.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -1,20 +1,23 @@
-..\Pygccxml_Dev\Pygccxml\Utils Documentation
-============================================
+======================
+pygccxml.utils package
+======================
 
-This page contains the ..\Pygccxml_Dev\Pygccxml\Utils Package documentation.
+This page contains the `pygccxml.utils` package API documentation.
 
-The :mod:`utils.fs_utils` Modules
+The :mod:`pygccxml.utils` package
 ---------------------------------
 
-.. automodule:: pygccxml.utils.fs_utils
+.. automodule:: pygccxml.utils
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`..\pygccxml_dev\pygccxml\utils` Package
--------------------------------------------------
 
-.. automodule:: pygccxml.utils
+
+The :mod:`utils.fs_utils` module
+---------------------------------
+
+.. automodule:: pygccxml.utils.fs_utils
     :members:
     :undoc-members:
     :show-inheritance:

Modified: pygccxml_dev/docs/pygccxml.rest
===================================================================
--- pygccxml_dev/docs/pygccxml.rest	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/docs/pygccxml.rest	2009-01-29 22:14:51 UTC (rev 1641)
@@ -111,7 +111,7 @@
 ----------------
 
 `pygccxml`_ comes with comprehensive unit tests. They are executed on Windows XP
-and `Ubuntu`_ Linux operating system. In most cases Python 2.5 and 2.6 are used.
+and `Ubuntu`_ Linux operating systems. In most cases Python 2.5 and 2.6 are used.
 I still maintain backward compatibility to Python 2.4. All in all, `pygccxml` has
 more than 230 tests.
 
@@ -120,7 +120,6 @@
 -------------------------------
 
 .. toctree::
-   :maxdepth: 2
 
    example/example.rest
    download.rest

Modified: pygccxml_dev/pygccxml/parser/__init__.py
===================================================================
--- pygccxml_dev/pygccxml/parser/__init__.py	2009-01-29 19:49:51 UTC (rev 1640)
+++ pygccxml_dev/pygccxml/parser/__init__.py	2009-01-29 22:14:51 UTC (rev 1641)
@@ -34,7 +34,8 @@
            , config=None
            , compilation_mode=COMPILATION_MODE.FILE_BY_FILE
            , cache=None ):
-    """Parse header files.
+    """
+    Parse header files.
 
     @param files: The header files that should be parsed
     @type files: list of str
@@ -46,7 +47,6 @@
     @type cache: L{cache_base_t} or str
     @returns: Declarations
     """
-
     if not config:
         config = config_t()
     parser = project_reader_t( config=config, cache=cache )


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


