Skip to content

Commit 7d21cd4

Browse files
author
roman_yakovenko
committed
docs
1 parent fe0d0d8 commit 7d21cd4

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/design.rest

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,26 @@ pygccxml design
66
The view from 10000 fits
77
------------------------
88

9-
:doc:`pygccxml <pygccxml>` has 3 packages:
9+
:doc:`pygccxml <pygccxml>` has 4 packages:
1010

11-
* ``declarations`` package defines classes that describe C++ declarations and types
11+
* :mod:`declarations <pygccxml.declarations>` package defines classes that describe
12+
C++ declarations and types
1213

13-
* ``parser`` package defines classes that parse `GCC-XML`_ generated files. Also
14-
it defines few classes that will help you to eliminate unnecessary parsing of
15-
C++ source files.
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+
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.
1621

1722
* ``utils`` package defines few functions, I found useful in the whole project.
1823

1924
-------------------------
2025
``declarations`` package
2126
-------------------------
2227

23-
Please take a look on `UML diagram`_. This `UML diagram`_ describes almost all
28+
Please take a look on the `UML diagram`_. This `UML diagram`_ describes almost all
2429
classes defined in the package and their relationship. ``declarations`` package
2530
defines two hierarchies of class:
2631

0 commit comments

Comments
 (0)