iceddoc/test/example.coffee

An API documentation generator for IcedCoffeeScript

###
# CoffeeDoc example documentation #

This is a module-level docstring, and will be displayed at the top of the module documentation.
Documentation generated by [CoffeeDoc](http://github.com/omarkhan/coffeedoc).
###

class MyClass extends Superclass
    ###
    This docstring documents MyClass. It can include *Markdown* syntax,
    which will be converted to html.
    ###
    constructor: (@args) ->
        ### Constructor documentation goes here. ###

    method: (args) ->
        ### This is a method of MyClass. ###

myFunc = (arg1, arg2, args...) ->
    ###
    This function will be documented by CoffeeDoc.
    ###
    doSomething()