Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added source file from readme example to tests

  • Loading branch information...
commit a77b141088e593a244ad99dca43d90bbedb2ba9b 1 parent 37e7bb6
@omarkhan authored
Showing with 23 additions and 0 deletions.
  1. +23 −0 test/example.coffee
View
23 test/example.coffee
@@ -0,0 +1,23 @@
+###
+# 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()
Please sign in to comment.
Something went wrong with that request. Please try again.