[cfe-dev] [PATCH] LibTooling docs

Sean Silva silvas at purdue.edu
Sun Apr 22 18:11:39 PDT 2012

Fwiw, when it comes to a kind of "code walkthrough", I think that something
like this <http://documentcloud.github.com/underscore/docs/underscore.html>
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 <
http://jashkenas.github.com/docco/>). There are ports of this tool for many
languages (they are listed on that page) and they are all equally small.

--Sean Silva

On Sun, Apr 22, 2012 at 5:37 AM, David Röthlisberger <david at rothlis.net>wrote:

> On 21 Apr 2012, at 18:42, David Blaikie wrote:
> >> On Sat, 21 Apr 2012 14:28:03 +0100
> >> David Röthlisberger <david at rothlis.net> wrote:
> >> I am a big fan of *testable* documentation.
> >
> > Manuel - sorry if this takes a bit of a tangent from your review... I
> > don't think any of this is likely to be sufficiently
> > relevant/important to require you to respond before committing your
> > documentation.
> 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.
> --David Röthlisberger.
> _______________________________________________
> cfe-dev mailing list
> cfe-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20120422/02107e0b/attachment.html>

More information about the cfe-dev mailing list