|
From: <rom...@us...> - 2006-08-05 18:33:46
|
Revision: 381 Author: roman_yakovenko Date: 2006-08-05 11:33:36 -0700 (Sat, 05 Aug 2006) ViewCVS: http://svn.sourceforge.net/pygccxml/?rev=381&view=rev Log Message: ----------- updating documentation Modified Paths: -------------- pyplusplus_dev/docs/documentation/index.rest Added Paths: ----------- pyplusplus_dev/docs/documentation/architecture.rest Added: pyplusplus_dev/docs/documentation/architecture.rest =================================================================== --- pyplusplus_dev/docs/documentation/architecture.rest (rev 0) +++ pyplusplus_dev/docs/documentation/architecture.rest 2006-08-05 18:33:36 UTC (rev 381) @@ -0,0 +1,68 @@ +============ +Architecture +============ + +.. contents:: Table of contents + +------------ +Introduction +------------ + +This document will describe an architecture behind `pyplusplus`_. If you just +started with `pyplusplus`_ you don't have to read this document. + +-------- +pygccxml +-------- + +What is exactly `pygccxml`_ for `pyplusplus`_. `pygccxml`_ provides next services: + +* definition of classes, that describe C++ declaration and types +* C++ source files parsing and caching functionality +* C++ class and type analizers( type traits ) + +`pyplusplus`_ uses those services to: + +* extract declarations from source files + +* find out declaration default configuration: + + * call policies for functions + + * indexing suite parameters + + * generate warnings/hints + + * ... + +* provide powerful query interface + +In general, `pygccxml`_ does all dirty work. + +--------------------- +decl_wrappers package +--------------------- + +This is the most important package in `pyplusplus`_. Why? Because this package +contains interface, that configure code generator engine. For example + + +pygccxml & decl_wrappers integration +------------------------------------ + +Almost every class in the ``decl_wrappers`` package derives from relevant class +defined in ``pygccxml.declarations` package. + + +.. _`pyplusplus` : ./../pyplusplus.html +.. _`boost.python`: http://www.boost.org/libs/python/doc/index.html +.. _`Python`: http://www.python.org +.. _`GCC-XML`: http://www.gccxml.org + +.. + Local Variables: + mode: indented-text + indent-tabs-mode: nil + sentence-end-double-space: t + fill-column: 70 + End: Modified: pyplusplus_dev/docs/documentation/index.rest =================================================================== --- pyplusplus_dev/docs/documentation/index.rest 2006-08-03 13:33:06 UTC (rev 380) +++ pyplusplus_dev/docs/documentation/index.rest 2006-08-05 18:33:36 UTC (rev 381) @@ -13,10 +13,10 @@ How can you help? -* Lets face it: today it is not possible to use `pyplusplus`_ without looking - into source code sometimes. `pyplusplus`_ uses `Epydoc`_ to generate - documentation from source files. So, if you found some undocumented piece of - code and you understand what it does, please write documentation string. +* Lets face it: today it is not possible to use `pyplusplus`_ without eventually + looking into source code. `pyplusplus`_ uses `Epydoc`_ to generate documentation + from source files. So, if you found some undocumented piece of code and you + understand what it does, please write documentation string. * You are reading documentation and my English cause you to scream? Please, fix those errors and send me new version of the document. I will integrate the This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
