[capi-sig] Documenting a C/Py API

[Martin Poirier]

--- Carsten Haese <carsten at uniqsys.com> wrote:

> On Mon, 2007-07-02 at 23:30 +1000, Campbell Barton
> wrote:
> > However Id be interested to know how other
> projects deal with the issue 
> > of maintaining docstrings and online docs.
> 
> I maintain separate docstrings and online docs for
> one simple reason:
> The online docs can be more extensive than
> docstrings. Docstrings are
> for brief memory-joggers. Online documentation can
> contain examples and
> generally more detail that's not appropriate for
> docstrings.

Can you elaborate on this a bit. What kind of tools do
you use to generate/maintain your docs?

Martin

- Blender developer


 
____________________________________________________________________________________
Finding fabulous fares is fun.  
Let Yahoo! FareChase search your favorite travel sites to find flight and hotel bargains.
http://farechase.yahoo.com/promo-generic-14795097