mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

documentation fixes

Browse Source
This commit is contained in:
vieron
2012-07-23 22:51:04 +02:00
parent aa939d8bf7
commit 4eb679fb78
17 changed files with 101 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.js
View File

@@ -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"
],

43
docs/classes/Collision Detects collisions between a DOM element against other DOM elements or Coords objects..html → docs/classes/Collision.html
View File

@@ -2,10 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</title>
<title>Collision</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
@@ -45,25 +42,9 @@ Coords objects.</title>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -108,10 +89,7 @@ collide.</a></li>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects. Class</h1>
<h1>Collision Class</h1>
<div class="box meta">
<div class="uses">
@@ -140,20 +118,15 @@ Coords objects. Class</h1>
<div class="box intro">
<p>Detects collisions between a DOM element against other DOM elements or
Coords objects.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects." class="method item">
<h3 class="name"><code>Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</code></h3>
<div id="method_Collision" class="method item">
<h3 class="name"><code>Collision</code></h3>
<div class="args">

53
docs/classes/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..html → docs/classes/Coords.html
View File

@@ -2,12 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>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.</title>
<title>Coords</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
@@ -47,25 +42,9 @@ collide.</title>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -110,12 +89,7 @@ collide.</a></li>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>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</h1>
<h1>Coords Class</h1>
<div class="box meta">
@@ -135,24 +109,17 @@ collide. Class</h1>
<div class="box intro">
<p>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.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_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="method item">
<h3 class="name"><code>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.</code></h3>
<div id="method_Coords" class="method item">
<h3 class="name"><code>Coords</code></h3>
<div class="args">

23
docs/classes/Draggable.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -125,7 +109,8 @@ collide.</a></li>
<div class="box intro">
<p>Basic drag implementation for DOM elements inside a container.
Provide start/stop/drag callbacks.</p>
</div>

60
docs/classes/Gridster.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -161,12 +145,6 @@ collide.</a></li>
</li>
<li class="arg">
<code class="optional">[avoid_overlapped_widgets]</code>
</li>
</ul><span class="paren">)</span>
</div>
@@ -371,6 +349,22 @@ collide.</a></li>
</div>
</li>
<li class="param">
<code class="param-name optional">[avoid_overlapped_widgets]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>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.</p>
</div>
</li>
<li class="param">
@@ -426,24 +420,6 @@ collide.</a></li>
</li>
<li class="param">
<code class="param-name optional">[avoid_overlapped_widgets]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>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.</p>
</div>
</li>
</ul>
</div>

39
docs/data.json
View File

@@ -5,7 +5,7 @@
"name": "src/jquery.collision.js",
"modules": {},
"classes": {
"Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.": 1
"Collision": 1
},
"fors": {},
"namespaces": {}
@@ -14,7 +14,7 @@
"name": "src/jquery.coords.js",
"modules": {},
"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.": 1
"Coords": 1
},
"fors": {},
"namespaces": {}
@@ -40,16 +40,19 @@
},
"modules": {},
"classes": {
"Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.": {
"name": "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.",
"shortname": "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.",
"Collision": {
"name": "Collision",
"shortname": "Collision",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"extension_for": [
"Gridster"
],
"file": "src/jquery.collision.js",
"line": 19,
"description": "Detects collisions between a DOM element against other DOM elements or\nCoords objects.",
"uses": [
"Coords"
],
@@ -97,16 +100,19 @@
},
"is_constructor": 1
},
"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.": {
"name": "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.",
"shortname": "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.",
"Coords": {
"name": "Coords",
"shortname": "Coords",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"extension_for": [
"Collision"
],
"file": "src/jquery.coords.js",
"line": 10,
"description": "Creates 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.",
"params": [
{
"name": "obj",
@@ -132,6 +138,7 @@
],
"file": "src/jquery.draggable.js",
"line": 24,
"description": "Basic drag implementation for DOM elements inside a container.\nProvide start/stop/drag callbacks.",
"params": [
{
"name": "el",
@@ -269,6 +276,12 @@
"type": "Boolean",
"optional": true
},
{
"name": "avoid_overlapped_widgets",
"description": "Avoid that widgets loaded\n from the DOM can be overlapped. It is helpful if the positions were\n bad stored in the database or if there was any conflict.",
"type": "Boolean",
"optional": true
},
{
"name": "serialize_params",
"description": "Return the data you want\n for each widget in the serialization. Two arguments are passed:\n `$w`: the jQuery wrapped HTMLElement, and `wgd`: the grid\n coords object (`col`, `row`, `size_x`, `size_y`).",
@@ -288,12 +301,6 @@
"optional": true
}
]
},
{
"name": "avoid_overlapped_widgets",
"description": "Avoid that widgets loaded\n from the DOM can be overlapped. It is helpful if the positions were\n bad stored in the database or if there was any conflict.",
"type": "Boolean",
"optional": true
}
],
"is_constructor": 1

23
docs/files/src_jquery.collision.js.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -128,11 +112,10 @@ collide.</a></li>
&#x2F;**
* @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

23
docs/files/src_jquery.coords.js.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -119,13 +103,12 @@ collide.</a></li>
;(function($, window, document, undefined){
&#x2F;**
* @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.

24
docs/files/src_jquery.draggable.js.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -133,8 +117,10 @@ collide.</a></li>
&#x2F;**
* @class Draggable
* Basic drag implementation for DOM elements inside a container.
* Provide start&#x2F;stop&#x2F;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

22
docs/files/src_jquery.gridster.js.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/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..html">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.</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Draggable.html">Draggable</a></li>
@@ -169,7 +153,7 @@ collide.</a></li>
* &#x60;&lt;head&gt;&#x60; of the document. You can set this to false, and write
* your own CSS targeting rows and cols via data-attributes like so:
* &#x60;[data-col=&quot;1&quot;] { left: 10px; }&#x60;
* @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

20
docs/index.html
View File

@@ -42,25 +42,9 @@
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href=".&#x2F;classes/Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects..html">Collision
Detects collisions between a DOM element against other DOM elements or
Coords objects.</a></li>
<li><a href=".&#x2F;classes/Collision.html">Collision</a></li>
<li><a href=".&#x2F;classes/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..html">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.</a></li>
<li><a href=".&#x2F;classes/Coords.html">Coords</a></li>
<li><a href=".&#x2F;classes/Draggable.html">Draggable</a></li>