kicad-developers team mailing list archive

[Wayne Stambaugh <stambaughw@xxxxxxxxx>]

On 6/12/2018 9:34 AM, John Beard wrote:
> Hi Nick and Wayne,
> 
> The patches as they are don't hook into the existing Python API doxygen
> stuff as it's not exactly the same as the Python API, it's a helper
> layer on top of that, and I was't sure if that would be OK.
> 
> I will take a look at adding it to the existing Python doc generation if
> that's an acceptable way to present it.

This makes more sense to me than adding it to the c++ source documentation.

> 
> Cheers,
> 
> John
> 
> On Tue, Jun 12, 2018 at 2:11 PM, Nick Østergaard <oe.nick@xxxxxxxxx
> <mailto:oe.nick@xxxxxxxxx>> wrote:
> 
>     We already have doxygen generation for the python API, although
>     people say that it is easier to read the C++ one. It is generated
>     with the doxygen-python make target.
>     See http://docs.kicad-pcb.org/doxygen-python/
>     <http://docs.kicad-pcb.org/doxygen-python/>
> 
>     Does the additions in 0002 add to the normal python docs?
> 
>     2018-06-12 15:07 GMT+02:00 Wayne Stambaugh <stambaughw@xxxxxxxxx
>     <mailto:stambaughw@xxxxxxxxx>>:
> 
>         Hey John,
> 
>         I like the idea of using doxygen to document the python
>         plugins.  The
>         current Doxyfile does not include .py files so that would need to
>         change.  Before we do that, I would like to see a new section (maybe
>         "Python Plugins") added to the documentation to separate the python
>         plugin code from the c++ source documentation.  I can commit
>         your patch
>         as is and you can make the doxygen changes in a later patch or I can
>         wait for you to create a new patch with all of the changes.  I'm
>         fine
>         either way.
> 
>         Cheers,
> 
>         Wayne
> 
>         On 6/4/2018 7:33 AM, John Beard wrote:
>         > Hi,
>         >
>         > Here is a simple patch sequence for the Python Footprint
>         Wizard helpers:
>         >
>         > 1) Minor spelling and formatting tidy-up
>         > 2) Add docstrings for the wizard base. As this is intended to
>         be used
>         > by writers of new plugins, having the functions documented is
>         probably
>         > a Good Idea (TM)
>         > 3) Add rounded rectangle and chamfered rectangle helpers.
>         Useful for
>         > some footprints or even board outlines.
>         >
>         > I used Doxygen-style docstrings, but I haven't actually done
>         anything
>         > about building actual output docs with it. Any thoughts of if that
>         > should be done, and if so, where to put it?
>         >
>         > There shouldn't be anything here that will break existing
>         plugins, the
>         > only API changes are additions.
>         >
>         > Cheers,
>         >
>         > John
>         >
>         >
>         >
>         > _______________________________________________
>         > Mailing list: https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>         > Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>         > Unsubscribe : https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>         > More help   : https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>
>         >
> 
>         _______________________________________________
>         Mailing list: https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>         Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>         Unsubscribe : https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>         More help   : https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>
> 
> 
> 
>     _______________________________________________
>     Mailing list: https://launchpad.net/~kicad-developers
>     <https://launchpad.net/~kicad-developers>
>     Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>     <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>     Unsubscribe : https://launchpad.net/~kicad-developers
>     <https://launchpad.net/~kicad-developers>
>     More help   : https://help.launchpad.net/ListHelp
>     <https://help.launchpad.net/ListHelp>
> 
>