Help needed!

Py++ documentation is always under active development. It is not an easy task to create and maintain it. I will appreciate any help!

How can you help?

• Lets face it: today it is not possible to use Py++ without eventually looking into source code. Py++ 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 changes.
• Do you think, that the documentation is not clear, I will be glad to improve it, just point me to the place.

Overview

• API docs - contains API documentation, including source code, generated by epydoc

• STL containers - describes various methods to expose STL containers to Python

• architecture - describes the architecture behind Py++

• documentation string - explains how to automatically extract a documentation from the source files and put it as Python documentation string

• functions & operators - contains a complete guide to exposing functions and operators, including "call policies" and description of different caveats

• how to ... ? - contains answers for different FAQs and my suggestions about better Py++ usage.

• inserting code - a complete guide for insert your code into the generated one

• multi-module development - describes how expose hierarchy of classes, which is spread few different libraries

• properties - describes how to create class properties using Py++ and built-in algorithm for automatic properties recognition

• splitting generated code to files - Py++ provides 4 different strategies

  for splitting the generated code into files. Take a look on this document, it will save you the time.

• tutorials - don't know where to start? Start here. Small and simple example will help you to start with Py++. If you want to evaluate Py++ you will find here small and handy GUI program.

• warnings - Py++ could be used as some kind of validator. It checks the exposed declarations and reports the potential errors. Thus you are able to create high quality Python bindings from the beginning. This document also describes how to suppress the errors\warnings.