https://github.com/schteppe/doc.js

Web based on-the-fly documentation generator targeted for JavaScript.
https://github.com/schteppe/doc.js

Last synced: about 2 months ago
JSON representation

Web based on-the-fly documentation generator targeted for JavaScript.

• Host: GitHub
• URL: https://github.com/schteppe/doc.js
• Owner: schteppe
• Created: 2012-04-03T07:59:42.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-09-21T09:17:17.000Z (over 12 years ago)
• Last Synced: 2024-04-10T16:19:59.517Z (9 months ago)
• Language: JavaScript
• Homepage: http://schteppe.github.com/doc.js
• Size: 404 KB
• Stars: 11
• Watchers: 5
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# Doc.js

## Example usage

Let's say you have the following javascript code:

```javascript

/**

 * @function add

 * @param float a

 * @param float b

 * @return float

 */

function add(a,b){

  return a+b;

}

```

To make a live doc.js documentation site, add doc.js and this HTML file to a public folder:

```html

  

    

  

  

  

    

    

    

      DOCJS.Generate(["myfile.js"]);