Book Image

Mastering jQuery

By : Alex Libby
Book Image

Mastering jQuery

By: Alex Libby

Overview of this book

<p>Mastering jQuery has been written not only to help maximize your skills with core functionality in the library, but also to explore some of the more intriguing ways of using the library to achieve real-world solutions that could feature on any website or online environment.</p> <p>You'll start with a look at some of the more advanced ways to incorporate the library into your pages, followed by working with forms and advanced form validation using regular expressions. Next you'll move on to animating in jQuery, advanced event handling, and using jQuery effects.</p> <p>Finally, you will develop practical examples of using jQuery with external functionality such as node-webkit, before finishing with a session on optimizing your version of the library for maximum efficiency and exploring best practices for using QUnit.</p>
Table of Contents (21 chapters)
Mastering jQuery
Credits
About the Author
About the Reviewers
www.PacktPub.com
Preface
Index

Automating the provision of documentation


The final stage in developing our plugin skills is the provision of documentation. Any coder can produce documentation, but the mark of a better developer is to produce quality documentation, without the need to have to spend lots of time on it.

Enter JSDoc! It is available from https://github.com/jsdoc3/jsdoc. If you're not already familiar with it, this is a great way to create your documentation that not only looks good, but can easily be automated using Node. Let's take a moment to install it, and see it work in action. Following steps need to be performed for this:

  1. We'll start this time by installing JSDoc via NodeJS. For this we need to bring up a NodeJS command prompt; there will be an icon for this in your Programs menu, or from the Start page if using Windows 8.

  2. At the command prompt, change the location to your project folder, then enter the following command:

    npm install –g jsdoc
    
  3. Node will run through the installation before confirming that...