22Design overview
33===============
44
5- ------------------------
6- The view from 10000 fits
7- ------------------------
8-
95pygccxml has 4 packages:
106
11- * :mod: `declarations <pygccxml.declarations> ` package defines classes that describe
12- C++ declarations and types
7+ * :mod: `declarations <pygccxml.declarations> `
8+
9+ This package defines classes that describe C++ declarations and types.
10+
11+ * :mod: `parser <pygccxml.parser> `
12+
13+ This package defines classes that parse `GCC-XML `_
14+ or `CastXML `_ generated files. It also defines a few classes that will help
15+ you unnecessary parsing of C++ source files.
1316
14- * :mod: `parser <pygccxml.parser> ` package defines classes that parse `GCC-XML `_
15- generated files. Also it defines few classes that will help you to eliminate
16- unnecessary parsing of C++ source files.
17+ * :mod: `binary_parsers <pygccxml.binary_parsers> `
1718
18- * :mod: `binary_parsers <pygccxml.binary_parsers> ` package extracts some
19- information from binary files ( `.so `, `.dll `, `.map ` ) and merges it with
20- the declarations tree.
19+ This package extracts information from binary files (`.so `, `.dll `, `.map `)
20+ and merges it with the declarations tree.
2121
22- * `` utils `` package defines few functions, I found useful in the whole project.
22+ * :mod: ` utils <pygccxml.utils> `
2323
24- -------------------------
24+ This package defines a few functions useful for the whole project,
25+ but which are mainly used internally by pygccxml.
26+
27+ ------------------------
2528``declarations `` package
26- -------------------------
29+ ------------------------
2730
2831Please take a look on the `UML diagram `_. This `UML diagram `_ describes almost all
2932classes defined in the package and their relationship. ``declarations `` package
@@ -275,6 +278,13 @@ This is not the only bug, which could be fixed, there are few of them. pygccxml
275278introduces few classes, which knows how to deal with specific bug. More over, those
276279bugs are fixed, only if I am 101% sure, that this is the right thing to do.
277280
281+ -----------------
282+ ``utils `` package
283+ -----------------
284+
285+ Use internally by pygccxml.
286+ Some methods/classes may be still usefull: loggers, find_xml_generator
287+
278288-------
279289Summary
280290-------
@@ -287,6 +297,7 @@ information please read API documentation.
287297.. _`SourceForge` : http://sourceforge.net/index.php
288298.. _`Python` : http://www.python.org
289299.. _`GCC-XML` : http://www.gccxml.org
300+ .. _`CastXML` : https://github.com/CastXML/CastXML
290301.. _`UML diagram` : declarations_uml.png
291302.. _`parser package UML diagram` : parser_uml.png
292303.. _`ReleaseForge` : http://releaseforge.sourceforge.net
0 commit comments