fdoc - API documentation generator.

[vic]

Now we have class/method documentation strings implemented in fancy, we could start writing the "fdoc" tool to generate documentation from fancy source. We could use markdown for docstrings.

I'd like it to generate something similar to..

http://rubydoc.info/docs/ruby-core/1.9.2/frames

Maybe we could reuse their templates.

Btw, you can set documentation strings for any method (even ruby ones of course)

 String instance_method: 'split . documentation: "Split an string by separator (ruby-method)"

 Fixnum documentation: "Class for fixed numbers."

[bakkdoor]

It would be nice to have a method's signature in the docs as well, e.g. if you write:

def foo: bar bar: baz {
  """
  This is my docstring.
  """
}

It would output something like this as the documentation:

foo: bar bar: baz
This is my docstring.

Or something similar. The point is to not only have the method name itself (foo:bar:) but also the argument names.

[vic]

Good, count on it.

Done. Documented methods display the arg name they use. We have a 'meta slot on Documentation objects we use to store a hash like <[ 'args => ['bar, 'baz] ]>

[bakkdoor]

Idea: For each method, allow to see the source for that method as well. E.g. as here: http://ruby-doc.org/core/classes/Array.html#M002175 If you click on the method name, you see the code. Note: We can add this later, just an idea I had and wanted to write down for later.

[vic]

Cool , i'll implement this.

[bakkdoor]

Great =D