Skip to content

tnyuan/docco

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

 ____                                                      
/\  _`\                                                    
\ \ \/\ \        ___         ___         ___         ___   
 \ \ \ \ \      / __`\      /'___\      /'___\      / __`\ 
  \ \ \_\ \    /\ \ \ \    /\ \__/     /\ \__/     /\ \ \ \
   \ \____/    \ \____/    \ \____\    \ \____\    \ \____/
    \/___/      \/___/      \/____/     \/____/     \/___/ 


Docco is a quick-and-dirty, hundred-line-long, literate-programming-style
documentation generator. For more information, see:

http://jashkenas.github.com/docco/

===================================================================

This fork supports JSDoc style comments and highlights declared parameters.

Example:

/**
 * @description Lolify someone's name
 * @param {String} name A person's name
 */
function lolify(name) {
   return 'OH HAI ' + name + ' KTHXBAI';
}

About

Literate Programming can be Quick and Dirty.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 97.7%
  • JavaScript 2.3%