From airbaggins at gmail.com  Sun Dec 30 10:33:18 2007
From: airbaggins at gmail.com (William Robinson)
Date: Sun, 30 Dec 2007 10:33:18 +0000
Subject: [tinaa-devel] Example code sections,
	cross linked with documentation.
Message-ID: <477773EE.4080409@gmail.com>

It would be nice to be able to specify some functions/files/package as 
example code for one's API, then have that code included verbatim in 
HTML form in the documentation, with links to the functions it uses, and 
also to have a list of any uses from the API documentation to locations 
in the example code.

I'm not sure if any other documentation system includes this facility 
now, or if it's possible to hack it somehow for tinaa. I should imagine 
that you can do it with Doxygen by making an examples module and have it 
include a lot of information with everything, but probably quite untidy.

I don't know where to look for examples of this. It's kind of silly to 
have to include an example in every function's documentation of how to 
use it, when there will be a lot of overlap. I'm not sure where I could 
find an example of this, just thought it would be a great thing for 
tinaa to have.

Thanks
Bill


From cases at metabang.fogbugz.com  Sun Dec 30 16:24:41 2007
From: cases at metabang.fogbugz.com (FogBugz On Demand)
Date: Sun, 30 Dec 2007 11:24:41 -0500
Subject: [tinaa-devel] (Case 24) Connect documentation and example code
Message-ID: <20071230162543.C421A47C044@nsla1.fogcreek.com>

Hi William, 

I think that this is a great idea and it's certainly something that is lacking from most documentation. Connecting code and examples and references could really help folks to learn new systems and deepen their understanding of ones they already know.

On the other hand, I've got next to no time to make any forward progress on Tinaa. I'll certainly keep thinking about and hope to have more time in the future.

thanks,
--
Gary Warren King, metabang.com 
Cell: (413) 559 8738
Fax: (206) 338-4052
gwkkwg on Skype * garethsan on AIM