Re: JavaScript code documentation

[Colin Walters <walters verbum org>]

On Sun, Mar 1, 2009 at 1:02 PM, Sander Dijkhuis
<sander dijkhuis gmail com> wrote:
> Here is an attempt to use a tool called Code Illuminated for browsing and
> displaying GNOME Shell's JavaScript code along with its documentation:
> http://student.science.uva.nl/~sqdh/gs-mockup/doc/index.html
> (The documentation I added there probably isn't very informative, but it was
> just meant to have something to show.)

Wow, that's really quite cool; I hadn't seen Code Illuminated before.

> My proposal is to have an index.html file like linked above at js/index.html
> and document all the Shell's JavaScript code using this syntax.

Sounds good to me.  One thing I wonder is how extensible it is.  For
example, there's the generic gjs support for signals; would be quite
useful to have those listed.  And in the shell we have the convention
of having a .actor property for things which effectively subclass
Actor.  Might be nice to mark those somehow.

But regardless it's a big step up from no HTML docs.