[pygccxml-commit] source/pygccxml __init__.py,1.19,1.20

[Matthias B. <mb...@us...>]

Update of /cvsroot/pygccxml/source/pygccxml
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21030

Modified Files:
	__init__.py 
Log Message:
Added a module doc string. This text will be shown on the entry page. It contains a little introduction and pointers to the most important functions/classes.

Index: __init__.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pygccxml/__init__.py,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -d -r1.19 -r1.20
*** __init__.py	28 Feb 2006 07:11:08 -0000	1.19
--- __init__.py	8 Mar 2006 08:41:18 -0000	1.20
***************
*** 4,7 ****
--- 4,33 ----
  # http://www.boost.org/LICENSE_1_0.txt)
  
+ """Python gccxml frontend.
+ 
+ This package provides functionality to extract and inspect
+ declarations from C/C++ header files. This is accomplished
+ by invoking the external tool U{gccxml<http://www.gccxml.org/>}
+ which parses a header file and dumps the declarations as a
+ XML file. This XML file is then read by pygccxml and the contents
+ are made available as appropriate Python objects.
+ 
+ To parse a set of C/C++ header files you use the
+ L{parse()<parser.parse>} function in the L{parser} sub package which
+ returns a tree that contains all declarations found in the header
+ files. The root of the tree represents the main namespace C{::} and
+ the children nodes represent the namespace contents such as other
+ namespaces, classes, functions, etc. Each node in the tree is an
+ object of a type derived from the
+ L{declaration_t<declarations.declaration_t>} base class. An inner
+ node is always either a namespace (L{namespace_t<declarations.namespace_t>})
+ or a class (L{class_t<declarations.class_t>}) which are both derived
+ from L{scopedef_t<declarations.scopedef_t>}. Everything else (free functions,
+ member functions, enumerations, variables, etc.) is always a leaf.
+ You will find all those declaration classes in the L{declarations}
+ sub-package.
+ 
+ """
+ 
  import pygccxml.declarations as declarations
  import pygccxml.parser as parser
***************
*** 12,14 ****
  #TODO: 
  #  1. Write documentation for filtering functionality.
! #  2. Add "explicit" property for constructors
\ No newline at end of file
--- 38,40 ----
  #TODO: 
  #  1. Write documentation for filtering functionality.
! #  2. Add "explicit" property for constructors