Merge pull request jashkenas#26 from strathmeyer/master

more specific docs about non-.coffee files
vorg · Nov 7, 2011 · ffe1989 · ffe1989
2 parents 53862c0 + dbd49d6
commit ffe1989
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/resources/docco.jst b/resources/docco.jst
@@ -4,6 +4,7 @@
 <head>
   <title><%= title %></title>
   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta name="generator" value="docco by jeremy ashkenas">
   <link rel="stylesheet" media="all" href="docco.css" />
 </head>
 <body>

diff --git a/src/docco.coffee b/src/docco.coffee
@@ -1,13 +1,16 @@
 # **Docco** is a quick-and-dirty, hundred-line-long, literate-programming-style
-# documentation generator. It produces HTML that displays your comments
-# alongside your code. Comments are passed through
+# documentation generator for JavaScript or CoffeeScript. It produces HTML
+# that displays your comments alongside your code. Comments are passed through
 # [Markdown](http://daringfireball.net/projects/markdown/syntax), and code is
 # passed through [Pygments](http://pygments.org/) syntax highlighting.
 # This page is the result of running Docco against its own source file.
 #
 # If you install Docco, you can run it from the command-line:
 #
 #     docco src/*.coffee
+# or
+#
+#     docco src/*.js
 #
 # ...will generate an HTML documentation page for each of the named source files, 
 # with a menu linking to the other pages, saving it into a `docs` folder.
@@ -22,6 +25,11 @@
 #
 #     sudo npm install docco
 #
+# When used to process JavaScript files, docco will only process end of line (`//`)
+# style comments, and only when they appear on a line by themselves.  Block comments
+# (`/* ... */`) and end of line comments on the same line as code (`var x = 1 // like this`)
+# are ignored by docco and will appear in your code.
+#
 #### Partners in Crime:
 #
 # * If **Node.js** doesn't run on your platform, or you'd prefer a more