From deadcc668bc3200b467b8be66d44fb644bb0aab2 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 30 Apr 2014 22:33:06 -0400 Subject: [PATCH] adding basic documentation for the admin javascript file this may eventually be removed and placed into the boilerplate's documentation on the official website, but until that exists, it will remain here. --- .../trunk/admin/js/plugin-name-admin.js | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/plugin-name/trunk/admin/js/plugin-name-admin.js b/plugin-name/trunk/admin/js/plugin-name-admin.js index eb361d9..b7e0a7f 100644 --- a/plugin-name/trunk/admin/js/plugin-name-admin.js +++ b/plugin-name/trunk/admin/js/plugin-name-admin.js @@ -1,4 +1,28 @@ (function( $ ) { 'use strict'; + /** + * @TODO + * + * All of the code for your Dashboard-specific JavaScript source + * should reside in this file. + * + * Note that this assume you're going to user jQuery, so it prepares + * the $ function reference to be used within the scope of this + * function. + * + * From here, you're able to define handlers for when the DOM is + * ready: + * + * $(function() { + * }); + * + * Or when the window is completely ready: + * + * $( window ).load(function() { + * }); + * + * ...and so on. + */ + })( jQuery ); \ No newline at end of file