From 6271822cb14a33503008ca99329423e0c1015953 Mon Sep 17 00:00:00 2001 From: Tom McFarlin Date: Wed, 30 Apr 2014 22:56:27 -0400 Subject: [PATCH] adding simple public-facing code comments --- .../trunk/public/js/plugin-name-public.js | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/plugin-name/trunk/public/js/plugin-name-public.js b/plugin-name/trunk/public/js/plugin-name-public.js index eb361d9..d0346c4 100644 --- a/plugin-name/trunk/public/js/plugin-name-public.js +++ b/plugin-name/trunk/public/js/plugin-name-public.js @@ -1,4 +1,28 @@ (function( $ ) { 'use strict'; + /** + * @TODO + * + * All of the code for your public-facing 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