[Bf-python] Meeting minutes 24-05 + invitation 31-05
Ramanan Selvaratnam
rama at uklinux.net
Thu May 29 23:44:06 CEST 2003
Michel Selten wrote:
>[...]
>
>Documentation and Testing:
>--------------------------
>- A directory needs to be created in CVS that will contain all testing
> scripts.
>- The documentation for the API needs to be updated. Not only the new
> modules are in need of documentation, but the current status of 2.25
> docs is in need of updates. There are some errors in there.
> guignot will mail the Curve, Metaballs and Effect API documentation
> to the bf-python mailing list.
>- Using Doxygen, the internals of the Python API can be described, not
> the api itself. For now, a plain simple text format is sufficient. It
> can be converted to docbook later.
>
I am not sure what ' describing the API' is?
Would this be of any help?
<http://www.gnu.org/directory/devel/prog/python/epydoc.html>
> A module documentation should contain the following sections:
>
Sorry to be a bit late here...
Who is the intended audience? (programmers or complete newcomers who
want to write plugins or middleground or even a progression through the
python interface docs.)
It will be easier to write up if the audience is specified for each of
the following points.
> 1 - General Description
>
Is it supposed to start like this.....
' This document outlines the interface to scripting Blender through
python....'
or an even more general view of what can be and cannot be done?
> 2 - Functions of the module
>
I am a bit confused here.
Is it not about 'modules' (in the plural) and about what they can do?
like this.....
"Camera module
blahblahblah....."
"Lamp module
blahblahblah...."
> 3 - Variables of the objects of the module
> 4 - Functions of the objects of the module
>
>
Functions (and variables and objects) here is in a technical sense as
opposed to point 2.
Correct?
All the best,
Ramanan
More information about the Bf-python
mailing list