From 4eb679fb78035c171f8388f8b08da279c32387f7 Mon Sep 17 00:00:00 2001 From: vieron Date: Mon, 23 Jul 2012 22:51:04 +0200 Subject: [PATCH] documentation fixes --- dist/jquery.gridster.js | 12 ++-- docs/api.js | 4 +- .../classes/Collision.html | 43 +++---------- .../classes/Coords.html | 53 ++++------------ docs/classes/Draggable.html | 23 ++----- docs/classes/Gridster.html | 60 ++++++------------- docs/data.json | 39 +++++++----- docs/files/src_jquery.collision.js.html | 23 +------ docs/files/src_jquery.coords.js.html | 23 +------ docs/files/src_jquery.draggable.js.html | 24 ++------ docs/files/src_jquery.gridster.js.html | 22 +------ docs/index.html | 20 +------ index.html | 16 ++--- src/jquery.collision.js | 3 +- src/jquery.coords.js | 3 +- src/jquery.draggable.js | 4 +- src/jquery.gridster.js | 2 +- 17 files changed, 101 insertions(+), 273 deletions(-) rename "docs/classes/Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects..html" => docs/classes/Collision.html (88%) rename "docs/classes/Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide..html" => docs/classes/Coords.html (79%) diff --git a/dist/jquery.gridster.js b/dist/jquery.gridster.js index 2cc3b61937..769ba2b41d 100644 --- a/dist/jquery.gridster.js +++ b/dist/jquery.gridster.js @@ -4,13 +4,12 @@ ;(function($, window, document, undefined){ /** - * @class Coords - * * Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) * to simulate DOM elements on the screen. * Coords is used by Gridster to create a faux grid with any DOM element can * collide. * + * @class Coords * @param {HTMLElement|Object} obj The jQuery HTMLElement or a object with: left, * top, width and height properties. * @return {Object} Coords instance. @@ -115,11 +114,10 @@ /** - * @class Collision - * * Detects collisions between a DOM element against other DOM elements or * Coords objects. * + * @class Collision * @uses Coords * @param {HTMLElement} el The jQuery wrapped HTMLElement. * @param {HTMLElement|Array} colliders Can be a jQuery collection @@ -380,8 +378,10 @@ /** - * @class Draggable + * Basic drag implementation for DOM elements inside a container. + * Provide start/stop/drag callbacks. * + * @class Draggable * @param {HTMLElement} el The HTMLelement that contains all the widgets * to be dragged. * @param {Object} [options] An Object with all options you want to @@ -657,7 +657,7 @@ * `` of the document. You can set this to false, and write * your own CSS targeting rows and cols via data-attributes like so: * `[data-col="1"] { left: 10px; }` - * @param {Boolean} [avoid_overlapped_widgets] Avoid that widgets loaded + * @param {Boolean} [options.avoid_overlapped_widgets] Avoid that widgets loaded * from the DOM can be overlapped. It is helpful if the positions were * bad stored in the database or if there was any conflict. * @param {Function} [options.serialize_params] Return the data you want diff --git a/docs/api.js b/docs/api.js index 47d6d2545a..8b7efa7acb 100644 --- a/docs/api.js +++ b/docs/api.js @@ -1,8 +1,8 @@ YUI.add("yuidoc-meta", function(Y) { Y.YUIDoc = { meta: { "classes": [ - "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.", - "Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.", + "Collision", + "Coords", "Draggable", "Gridster" ], diff --git "a/docs/classes/Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects..html" b/docs/classes/Collision.html similarity index 88% rename from "docs/classes/Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects..html" rename to docs/classes/Collision.html index 7b89b6fc6c..50a0adafe5 100644 --- "a/docs/classes/Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects..html" +++ b/docs/classes/Collision.html @@ -2,10 +2,7 @@ - Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. + Collision @@ -45,25 +42,9 @@ Coords objects.