Hello everyone,

I've been working on porting Prototype online documentation to PDoc
inline comments.
Current work in progress is visible on my GitHub fork [1], it is based
on "rewrite" branch which has been merged in "master" a few days ago.
All "lang" methods are declared there, Some of them contain both
description and explicit arguments description,
vast majority contain only method signature and description visible on
current documentation's listing pages [2], and few of them are blank
and marked as TODO.

I had to implement nested optional arguments in order to have
signatures like "String#truncate([length = 30[, suffix = '...']])"
handled by the parser. This patch is attached to a ticket on
LightHouse [3].

I also had to add "require 'rubygems'" in pdoc.rb to have BlueCloth
loaded nicely when running tests from TextMate, and add a a rescue
clause in LinkHelper#auto_link and LinkHelper#path_to because they
appear to be called with a nil argument, and I can't figure out why...

With above modifications, you can actually generate the website using
"pdoc" command.
On my Core 2 Duo laptop, parsing takes approximately 25s, and
generation 8s.

Someone interrested in helping porting documentation ?

[2] http://prototypejs.org/api/enumerable
You received this message because you are subscribed to the Google Groups 
"Prototype: Core" group.
To post to this group, send email to prototype-core@googlegroups.com
To unsubscribe from this group, send email to 
For more options, visit this group at 

Reply via email to