Permalink
Browse files

Remove JS Doc autogeneration

  • Loading branch information...
1 parent 4179da4 commit eb3ef38679d4d5eb0cbf70b495fdc5fff7257885 @sarahgp committed Aug 29, 2015
View
@@ -18,7 +18,6 @@
* start the connect server and leave it running; the tests
* can then be opened at localhost:9001/test/test.html
*
- * grunt jsdoc - Generate documentation from inline code.
*
* grunt watch:main - This watches the source for changes and rebuilds on
* every file change.
@@ -95,20 +94,6 @@ module.exports = function(grunt) {
}
},
- // Set up jsdoc task to generate documentation
- jsdoc : {
- dist : {
- src: ['src/client/app.js',
- 'src/client/lib/*.js',
- 'src/p5bots-server/app.js',
- 'src/p5bots-server/lib/*.js',
- 'doc/README.md'],
- options: {
- destination: 'doc'
- }
- }
- },
-
// Set up the watch task, used for live-reloading during development.
watch: {
// Watch the codebase for changes
@@ -195,7 +180,6 @@ module.exports = function(grunt) {
grunt.loadTasks('build/tasks');
grunt.loadNpmTasks('grunt-jscs');
grunt.loadNpmTasks('grunt-contrib-jshint');
- grunt.loadNpmTasks('grunt-jsdoc');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-mocha');
grunt.loadNpmTasks('grunt-mocha-chai-sinon');
@@ -204,7 +188,7 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-newer');
// Create the multitasks.
- grunt.registerTask('build', ['browserify', 'uglify', 'jsdoc']);
+ grunt.registerTask('build', ['browserify', 'uglify']);
grunt.registerTask('test', ['jshint', 'jscs', 'build', 'connect', 'mocha', 'mocha-chai-sinon']);
grunt.registerTask('default', ['test']);
};
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Binary file not shown.
Deleted file not rendered
View
Deleted file not rendered
View
@@ -1,101 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Home</title>
-
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
- <h1 class="page-title">Home</h1>
-
-
-
-
-
-
-
-
- <h3> </h3>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <section>
- <article><h1>Welcome to p5bots!</h1><ul>
-<li><a href="#how-does-this-work">How Does This Work?</a></li>
-<li><a href="#p5-serial">p5.Serial</a></li>
-<li><a href="#p5-board">p5.Board</a></li>
-<li><a href="#getting-started">Getting Started</a></li>
-<li><a href="#issues">Issues</a></li>
-<li><a href="#contributing">Contributing</a></li>
-</ul>
-<p><h2 id="how-does-this-work">How Does This Work?</h2>
-p5bots is a library that works to send messages from your browser, where you are running p5.js, to your microcontroller, most likely an Arduino. To do this, it uses the <code>socket.io</code> library and <code>node.js</code> to send messages between the two devices, in a language each device can understand.</p>
-<p>This way, you can click on a sketch to light an LED or use temperature data to drive a sketch — or more.</p>
-<p><img src="img/how-it-works.png" alt="diagram of client, server, and microcontroller"></p>
-<p>p5bots comprises two sets of files: the client file, called <code>p5bots.js</code>, which is included in the <code>index.html</code> along with <code>p5.js</code> and your sketch; and the server files, called <code>p5bots-server</code>, which can be downloaded from <a href="https://www.npmjs.com/package/p5bots-server">npm</a>.</p>
-<p>If all this sounds a little too manual, you can also use p5bots from the <a href="https://github.com/processing/p5.js-editor">p5.js IDE</a>.</p>
-<p><h2 id="p5-serial">p5.Serial</h2>
-p5bots has a <a href="doc/module-Serial.html">serial method</a> that can be used in combination with an Arduino sketch listening for serial, much in the same way the Processing serial library can.</p>
-<p>For more details on this module, see <a href="doc/module-Serial.html">the p5.Serial reference page</a>.</p>
-<p>If you use serial only, you do not need to install Firmata on your board.</p>
-<p><h2 id="p5-board">p5.Board</h2>
-The majority of p5bots functionality lives within p5.Board. Inspired by <a href="http://johnny-five.io/">Johnny-Five</a>, p5.Board provides a number of hardware-specific methods in addition to plain digital, analog, and pwm read/write methods.</p>
-<p>Details for these methods, plus examples can be found in the module pages. Example sketches and hardware diagrams are also available in <a href="https://github.com/sarahgp/p5bots/tree/master/examples">the examples directory on the p5bots Github</a>.</p>
-<p><h2 id="getting-started">Getting Started</h2>
-Ready to go? Good entry points include:</p>
-<ul>
-<li><a href="">the Hello, World tutorial</a></li>
-<li><a href="">checking out examples on the method pages, say RGB LED</a></li>
-<li>reading about <a href="https://github.com/sarahgp/p5bots">the client API</a> and <a href="https://github.com/sarahgp/p5bots/tree/master/src/p5bots-server">p5bots-server</a> on Github</li>
-<li>or, <a href="http://p5js.org/">heading over to p5.js to learn more about the drawing library</a></li>
-</ul>
-<p><h2 id="issues">Issues</h2>
-<a href="https://github.com/sarahgp/p5bots/issues">Report issues on Github.</a></p>
-<p><h2 id="contributing">Contributing</h2>
-Want to fix an issue you've identified? Looking to create some functionality we have yet to add? Check out the <a href="https://github.com/sarahgp/p5bots">p5bots repo on Github</a> and, particularly, <a href="https://github.com/sarahgp/p5bots/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p></article>
- </section>
-
-
-
-
-
-
-</div>
-
-<nav>
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Basic%2520constructors.html">Basic constructors</a></li><li><a href="module-Server-Side%2520Events_%2520LED.html">Server-Side Events: LED</a></li></ul><h3>Global</h3><ul><li><a href="global.html#button">button</a></li><li><a href="global.html#led">led</a></li><li><a href="global.html#motor">motor</a></li><li><a href="global.html#piezo">piezo</a></li><li><a href="global.html#rgb">rgb</a></li><li><a href="global.html#serial">serial</a></li><li><a href="global.html#servo">servo</a></li><li><a href="global.html#temp">temp</a></li><li><a href="global.html#vres">vres</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Sat Aug 29 2015 10:36:48 GMT-0400 (EDT)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>
View
@@ -1,121 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Source: led.js</title>
-
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
- <h1 class="page-title">Source: led.js</h1>
-
-
-
-
-
-
- <section>
- <article>
- <pre class="prettyprint source linenums"><code>/**
- * @module Server-Side Events: LED
- */
-
-/**
- * Listener for LED blink event, sends data to board, manages timing
- * @param {obj} board Reference to instantiated Firmata board
- * @param {obj} socket Reference to socket.io socket
- */
-exports.blink = function blink(board, socket) {
- socket.on('blink', function(data){
- var ledPin = data.pin,
- ledOn = true,
- length = data.length || 500;
-
- board.pinMode(ledPin, board.MODES.OUTPUT);
-
- var blinkID = setInterval(function() {
- if (ledOn) {
- board.digitalWrite(ledPin, board.HIGH);
- } else {
- board.digitalWrite(ledPin, board.LOW);
- }
-
- ledOn = !ledOn;
-
- }, length);
-
- socket.on('blink cancel', function(data) {
- clearInterval(blinkID);
- });
-
- });
-};
-
-/**
- * Listener for LED fade event, sends data to board, manages timing
- * @param {obj} board Reference to instantiated Firmata board
- * @param {obj} socket Reference to socket.io socket
- */
-exports.fade = function fade(board, socket) {
- socket.on('fade', function(data) {
- board.pinMode(data.pin, board.MODES.PWM);
-
- var time = data.time,
- start = data.start,
- stop = data.stop,
- inc = data.inc,
- steps = time / inc,
- span = Math.abs(start - stop),
- vps = span / steps,
- mult = stop > start ? 1 : -1,
- val = start;
-
-
- function nextVal(a, b) {
- return a + mult * b;
- }
-
- function setStep(num){
- setTimeout(function(){
- board.analogWrite(data.pin, val);
- val = nextVal(val, vps);
- }, num * inc);
- }
-
- for (var i = 0; i &lt;= steps; i++){
- setStep(i);
- }
- });
-};</code></pre>
- </article>
- </section>
-
-
-
-
-</div>
-
-<nav>
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Server-Side%2520Events_%2520LED.html">Server-Side Events: LED</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Aug 28 2015 19:03:10 GMT-0400 (EDT)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>
Oops, something went wrong.

0 comments on commit eb3ef38

Please sign in to comment.