[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

Re: Reimplementing code, was: gEDA-user: Free Dog meeting report: Notes on the topics we discussed



On Tuesday 20 September 2005 01:40 pm, Stuart Brorson wrote:

> One thing we do need, however, is more transparency into how the code
> works.  Personally, I have posted a .pdf drawing of (some of) the data
> structures used by libgeda & how they work at my website here:
>
> http://www.brorson.com/gEDA/gEDA_Structures_20050108.pdf

Most excellent.

> My little utility, gattrib, which is part of gEDA/gaf includes a bunch
> of (hopefully) high-level documentation in its source tree.  Finally,
> I have also started (but not finished or distributed) an OOO doc
> describing the calling args and returns from many (and someday all) of
> the fcns in libgeda.
>
> My point is this:  If there are others out there who share my view,
> I'd be happy to post my libgeda doc and let others investigate the
> libgeda, gschem, gnetlist, etc. code and add to the doc.  I think it
> would help enlarge the developement community if we had a better set
> of docs describing how the code works.
>
> In the end, I think more transparency into the existing code base
> would be much more useful than writing or re-writing anything in the
> latest hype-language.
>
> Let me know if you want to share the work of documenting libgeda!

Without a doubt, good documentation will foster faster development. If you 
post it on your website, I'll participate. 

Regards

Marvin

Attachment: pgpNGPfYDOnDK.pgp
Description: PGP signature