<div class="gmail_extra">Fwiw, when it comes to a kind of "code walkthrough", I think that something like this <<a href="http://documentcloud.github.com/underscore/docs/underscore.html">http://documentcloud.github.com/underscore/docs/underscore.html</a>> could be a good model. The docs are generated from comments *in the code*, so that they are unlikely to go out of date. The program that does that transformation is called Docco and it is very few lines of code (see here <<a href="http://jashkenas.github.com/docco/">http://jashkenas.github.com/docco/</a>>). There are ports of this tool for many languages (they are listed on that page) and they are all equally small.</div>
<div class="gmail_extra"><br></div><div class="gmail_extra">--Sean Silva</div><div class="gmail_extra"><br><div class="gmail_quote">On Sun, Apr 22, 2012 at 5:37 AM, David Röthlisberger <span dir="ltr"><<a href="mailto:david@rothlis.net" target="_blank">david@rothlis.net</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On 21 Apr 2012, at 18:42, David Blaikie wrote:<br>
>> On Sat, 21 Apr 2012 14:28:03 +0100<br>
>> David Röthlisberger <<a href="mailto:david@rothlis.net">david@rothlis.net</a>> wrote:<br>
</div><div class="im">>> I am a big fan of *testable* documentation.<br>
><br>
</div><div class="im">> Manuel - sorry if this takes a bit of a tangent from your review... I<br>
> don't think any of this is likely to be sufficiently<br>
> relevant/important to require you to respond before committing your<br>
> documentation.<br>
<br>
<br>
</div>Absolutely -- In fact I'm a bit sorry for distracting from the review of the documentation *content* by submitting my wacky ideas. Let's get Manuel's static html --which is really valuable work-- committed before carrying this discussion any further.<br>

<span class="HOEnZb"><font color="#888888"><br>
--David Röthlisberger.<br>
</font></span><div class="HOEnZb"><div class="h5"><br>
<br>
_______________________________________________<br>
cfe-dev mailing list<br>
<a href="mailto:cfe-dev@cs.uiuc.edu">cfe-dev@cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev</a><br>
</div></div></blockquote></div><br></div>