[erlang-questions] [ANN] "Reverse" help lookup a la railsapi.com

[Dmitrii Dimandt]

http://erlapi.prepor.ru/docs/

Have you ever worked through somebody else's code and wondered what
this or that function does? Thi is especially true when you're looking
at source code for a well-known project in search for tips on how to
solve certain problems.

What does c:nc/2 do? What options does inet:setopts/2 accept? And so on.

Andrew Rudenko [1] on the erlang-russian [2] mailing list decided to
solve this problem.

Getting his inspiration from the Rails API site [3], he made an analog
for Erlang: http://erlapi.prepor.ru/docs/

You may think "yeah, right, just a pretty doc site" and you'll be
wrong. Just try searching for the aforementioned c:nc and inet:setopts
functions to get the idea of what this really is.

- Generator (in Ruby) that was used to generate the docs is here: http://github.com/prepor/erlapi/tree
- You can download generated docs for local viewing here: http://github.com/prepor/erlapi-static/tree/master

[1] Andrew Rudenko: http://prepor.ru/

[2] erlang-russian mailing list: http://groups.google.com/group/erlang-russian/

[3] Rails API site: http://railsapi.com/doc/rails-v2.3.3.1/

________________________________________________________________
erlang-questions mailing list. See http://www.erlang.org/faq.html
erlang-questions (at) erlang.org

[Steve Davis]

This is excellent -

- one minor point -- erlang modules comprise "functions" not
"methods"! ;)

/sd

[Dmitrii Dimandt]

Good point :) I'll pass it on to the author

[Andrew Rudenko]

Fixed :)

> This is excellent -
>
> - one minor point -- erlang modules comprise "functions" not
> "methods"! ;)
>
> /sd

________________________________________________________________

[Dmitrii Dimandt]

Question to the list and people of Erlang :)

Do you think these docs could appear on Erlang's site alongside the
regular docs?

[Steve Davis]

A usability suggestion.

I and I suspect the majority of people rarely/never use modules from
CORBA or megaco. Would it be possible to fold those up (or link
separately) to avoid excessive scrolling every time?

regs,
/sd

On Aug 8, 2:32 pm, Dmitrii Dimandt <dmitr...@gmail.com> wrote:
> Question to the list and people of Erlang :)
>
> Do you think these docs could appear on Erlang's site alongside the  
> regular docs?
>
> On Aug 8, 2009, at 9:47 PM, Andrew Rudenko wrote:
>
> > Fixed :)
>
> >> This is excellent -
>
> >> - one minor point -- erlang modules comprise "functions" not
> >> "methods"! ;)
>
> >> /sd
>
> > ________________________________________________________________

> > erlang-questions mailing list. Seehttp://www.erlang.org/faq.html
> > erlang-questions (at) erlang.org
>
> ________________________________________________________________
> erlang-questions mailing list. Seehttp://www.erlang.org/faq.html

[Magnus Falk]

Honestly, the usability of the real erlang docs is abysmal. Javadoc beats it
in every single aspect. This is very welcome.

/Magnus