Decide API doc format - Githubissues

botanicus / rango

Rango is ultralightweight, ultracustomizable, ultracool web framework inspired by Django.

http://101ideas.cz

MIT License

221 stars 9 forks source link

Decide API doc format #9

Closed botanicus closed 15 years ago

botanicus commented 15 years ago

Write how the API documentation should looks like and reformat the old one.

botanicus commented 15 years ago

http://yard.soen.ca/what_is.html
http://yard.soen.ca/whats_new.html (see the @overload tag)

botanicus commented 15 years ago

It will be best to write what we need and discuss the syntax of the new features with YARD author, so he could possibly support the features in the feature.

botanicus commented 15 years ago

Our supposed extensions:

@experimental
@future 0.0.3 Change description
@param [Hash, @optional] options
@param [Hash[soft: Boolean(default true)]] options

botanicus commented 15 years ago

Everything except @experimental and @future seems to be supported in new version, see http://yard.soen.ca/getting_started