← Back to team overview

kicad-developers team mailing list archive

Re: Python scripting documentation


On 09/21/2013 03:39 AM, Miguel Angel wrote:
> Thoughts on this:
>     * The pythonland libraries need a serious refactor, at this moment all functions and 
> classes are brought together by swig into pcbnew.py: helper functions (LoadBoard,
> SaveBoard...) 
> unit conversion macros, scripting plugin definitions...
>     From the documentation perspective, it's a mess...
>     I think of refactoring into submodules:
>     *pcbnew*                   (with all the pcbnew objects)
>     *pcbnew.units  *       (with the unit helpers) 
>  http://bazaar.launchpad.net/~kicad-testing-committers/kicad/testing/view/head:/pcbnew/scripting/units.i
>    *pcbnew.helpers  *  
>  http://bazaar.launchpad.net/~kicad-testing-committers/kicad/testing/view/head:/pcbnew/scripting/module.i#L58
>  http://bazaar.launchpad.net/~kicad-testing-committers/kicad/testing/view/head:/pcbnew/scripting/pcbnew_scripting_helpers.cpp#L59
>  (backport this to python.)
>     *pcbnew.plugins*     (pcb footprint wizard plugins, etc..)
>    * There are many swig artifacts that get documented: _object, SwigPyIterator. We must
> find a way to get rid of the
> classes that get accidentally documented.

Have you considered the subsetting that is possible using a custom Doxygen configuration
file?  This lets you subset based on filename and file patterns.

I'm sorry but I don't have any more free brain cycles to help think this thru.  Maybe
Brian or Wayne can offer some help.