gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup spacing after @param

Browse Source
This commit is contained in:
Michal Čihař 2012-04-27 11:32:47 +02:00
parent b2243f08a8
commit e6cca75875
32 changed files with 420 additions and 420 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
js/common.js
View File

@ -17,7 +17,7 @@ var query_to_load = '';
/**
* sets current selected db
*
* @param string db name
* @param string db name
*/
function setDb(new_db)
{
@ -50,7 +50,7 @@ function setDb(new_db)
/**
* sets current selected table (called from navigation.php)
*
* @param string table name
* @param string table name
*/
function setTable(new_table)
{
@ -77,7 +77,7 @@ function setTable(new_table)
/**
* reloads main frame
*
* @param string url name of page to be loaded
* @param string url name of page to be loaded
*/
function refreshMain(url)
{
@ -101,7 +101,7 @@ function refreshMain(url)
/**
* reloads navigation frame
*
* @param boolean force force reloading
* @param boolean force force reloading
*/
function refreshNavigation(force)
{
@ -296,8 +296,8 @@ function refreshQuerywindow( url )
* opens new url in target frame, with default being left frame
* valid is 'main' and 'querywindow' all others leads to 'left'
*
* @param string targeturl new url to load
* @param string target frame where to load the new url
* @param string targeturl new url to load
* @param string target frame where to load the new url
*/
function goTo(targeturl, target)
{

4
js/config.js
View File

@ -274,8 +274,8 @@ function validateField(id, type, onKeyUp, params)
/**
* Returns valdiation functions associated with form field
*
* @param {String} field_id form field id
* @param {boolean} onKeyUpOnly see validateField
* @param {String} field_id form field id
* @param {boolean} onKeyUpOnly see validateField
* @type Array
* @return array of [function, paramseters to be passed to function]
*/

82
js/functions.js
View File

@ -60,7 +60,7 @@ $.ajaxPrefilter(function (options, originalOptions, jqXHR) {
* Add a hidden field to the form to indicate that this will be an
* Ajax request (only if this hidden field does not exist)
*
* @param object the form
* @param object the form
*/
function PMA_prepareForAjaxRequest($form)
{
@ -72,7 +72,7 @@ function PMA_prepareForAjaxRequest($form)
/**
* Generate a new password and copy it to the password input areas
*
* @param object the form that holds the password fields
* @param object the form that holds the password fields
*
* @return boolean always true
*/
@ -179,7 +179,7 @@ function displayPasswordGenerateButton()
/*
* Adds a date/time picker to an element
*
* @param object $this_element a jQuery object pointing to the element
* @param object $this_element a jQuery object pointing to the element
*/
function PMA_addDatepicker($this_element, options)
{
@ -219,10 +219,10 @@ function PMA_addDatepicker($this_element, options)
/**
* selects the content of a given object, f.e. a textarea
*
* @param object element element of which the content will be selected
* @param var lock variable which holds the lock for this element
* @param object element element of which the content will be selected
* @param var lock variable which holds the lock for this element
* or true, if no lock exists
* @param boolean only_once if true this is only done once
* @param boolean only_once if true this is only done once
* f.e. only on first focus
*/
function selectContent( element, lock, only_once )
@ -244,8 +244,8 @@ function selectContent( element, lock, only_once )
* Displays a confirmation box before submitting a "DROP/DELETE/ALTER" query.
* This function is called while clicking links
*
* @param object the link
* @param object the sql query to submit
* @param object the link
* @param object the sql query to submit
*
* @return boolean whether to run the query or not
*/
@ -282,8 +282,8 @@ function confirmLink(theLink, theSqlQuery)
* sumitting it if required.
* This function is called by the 'checkSqlQuery()' js function.
*
* @param object the form
* @param object the sql query textarea
* @param object the form
* @param object the sql query textarea
*
* @return boolean whether to run the query or not
*
@ -349,7 +349,7 @@ function confirmQuery(theForm1, sqlQuery1)
* Displays an error message if the user submitted the sql query form with no
* sql query, else checks for "DROP/DELETE/ALTER" statements
*
* @param object the form
* @param object the form
*
* @return boolean always false
*
@ -407,8 +407,8 @@ function checkSqlQuery(theForm)
* Check if a form's element is empty.
* An element containing only spaces is also considered empty
*
* @param object the form
* @param string the name of the form field to put the focus on
* @param object the form
* @param string the name of the form field to put the focus on
*
* @return boolean whether the form field is empty or not
*/
@ -423,8 +423,8 @@ function emptyCheckTheField(theForm, theFieldName)
/**
* Check whether a form field is empty or not
*
* @param object the form
* @param string the name of the form field to put the focus on
* @param object the form
* @param string the name of the form field to put the focus on
*
* @return boolean whether the form field is empty or not
*/
@ -441,10 +441,10 @@ function emptyFormElements(theForm, theFieldName)
/**
* Ensures a value submitted in a form is numeric and is in a range
*
* @param object the form
* @param string the name of the form field to check
* @param integer the minimum authorized value
* @param integer the maximum authorized value
* @param object the form
* @param string the name of the form field to check
* @param integer the minimum authorized value
* @param integer the maximum authorized value
*
* @return boolean whether a valid number has been submitted or not
*/
@ -671,7 +671,7 @@ var marked_row = new Array;
* marks all rows and selects its first checkbox inside the given element
* the given element is usaly a table or a div containing the table or tables
*
* @param container DOM element
* @param container DOM element
*/
function markAllRows(container_id)
{
@ -685,7 +685,7 @@ function markAllRows(container_id)
* marks all rows and selects its first checkbox inside the given element
* the given element is usaly a table or a div containing the table or tables
*
* @param container DOM element
* @param container DOM element
*/
function unMarkAllRows(container_id)
{
@ -698,8 +698,8 @@ function unMarkAllRows(container_id)
/**
* Checks/unchecks all checkbox in given conainer (f.e. a form, fieldset or div)
*
* @param string container_id the container id
* @param boolean state new value for checkbox (true or false)
* @param string container_id the container id
* @param boolean state new value for checkbox (true or false)
* @return boolean always true
*/
function setCheckboxes(container_id, state)
@ -712,9 +712,9 @@ function setCheckboxes(container_id, state)
/**
* Checks/unchecks all options of a <select> element
*
* @param string the form name
* @param string the element name
* @param boolean whether to check or to uncheck options
* @param string the form name
* @param string the element name
* @param boolean whether to check or to uncheck options
*
* @return boolean always true
*/
@ -1398,9 +1398,9 @@ $(function() {
* This will show a message that will not disappear automatically, but it
* can be dismissed by the user after he has finished reading it.
*
* @param string message string containing the message to be shown.
* @param string message string containing the message to be shown.
* optional, defaults to 'Loading...'
* @param mixed timeout number of milliseconds for the message to be visible
* @param mixed timeout number of milliseconds for the message to be visible
* optional, defaults to 5000. If set to 'false', the
* notification will never disappear
* @return jQuery object jQuery Element that holds the message div
@ -1505,7 +1505,7 @@ function PMA_ajaxShowMessage(message, timeout)
/**
* Removes the message shown for an Ajax operation when it's completed
*
* @param jQuery object jQuery Element that holds the notification
* @param jQuery object jQuery Element that holds the notification
*
* @return nothing
*/
@ -1673,7 +1673,7 @@ function PMA_createTableDialog( $div, url , target)
/**
* Creates a highcharts chart in the given container
*
* @param var settings object with highcharts properties that should be applied. (See also http://www.highcharts.com/ref/)
* @param var settings object with highcharts properties that should be applied. (See also http://www.highcharts.com/ref/)
* requires at least settings.chart.renderTo and settings.series to be set.
* In addition there may be an additional property object 'realtime' that allows for realtime charting:
* realtime: {
@ -1865,8 +1865,8 @@ function PMA_createProfilingChart(data, options)
/**
* Formats a profiling duration nicely (in us and ms time). Used in PMA_createProfilingChart() and server_status.js
*
* @param integer Number to be formatted, should be in the range of microsecond to second
* @param integer Acuracy, how many numbers right to the comma should be
* @param integer Number to be formatted, should be in the range of microsecond to second
* @param integer Acuracy, how many numbers right to the comma should be
* @return string The formatted number
*/
function PMA_prettyProfilingNum(num, acc)
@ -1890,7 +1890,7 @@ function PMA_prettyProfilingNum(num, acc)
/**
* Formats a SQL Query nicely with newlines and indentation. Depends on Codemirror and MySQL Mode!
*
* @param string Query to be formatted
* @param string Query to be formatted
* @return string The formatted query
*/
function PMA_SQLPrettyPrint(string)
@ -2041,10 +2041,10 @@ function PMA_SQLPrettyPrint(string)
* jQuery function that uses jQueryUI's dialogs to confirm with user. Does not
* return a jQuery object yet and hence cannot be chained
*
* @param string question
* @param string url URL to be passed to the callbackFn to make
* @param string question
* @param string url URL to be passed to the callbackFn to make
* an Ajax call to
* @param function callbackFn callback to execute after user clicks on OK
* @param function callbackFn callback to execute after user clicks on OK
*/
jQuery.fn.PMA_confirm = function(question, url, callbackFn) {
@ -2083,7 +2083,7 @@ jQuery.fn.PMA_confirm = function(question, url, callbackFn) {
* jQuery function to sort a table's body after a new row has been appended to it.
* Also fixes the even/odd classes of the table rows at the end.
*
* @param string text_selector string to select the sortKey's text
* @param string text_selector string to select the sortKey's text
*
* @return jQuery Object for chaining purposes
*/
@ -2832,7 +2832,7 @@ $(function() {
/**
* Ensures indexes names are valid according to their type and, for a primary
* key, lock index name to 'PRIMARY'
* @param string form_id Variable which parses the form name as
* @param string form_id Variable which parses the form name as
* the input
* @return boolean false if there is no index form, true else
*/
@ -2866,7 +2866,7 @@ function checkIndexName(form_id)
/**
* function to convert the footnotes to tooltips
*
* @param jquery-Object $div a div jquery object which specifies the
* @param jquery-Object $div a div jquery object which specifies the
* domain for searching footnootes. If we
* ommit this parameter the function searches
* the footnotes in the whole body
@ -3337,8 +3337,8 @@ $(function() {
/**
* Creates a message inside an object with a sliding effect
*
* @param msg A string containing the text to display
* @param $obj a jQuery object containing the reference
* @param msg A string containing the text to display
* @param $obj a jQuery object containing the reference
* to the element where to put the message
* This is optional, if no element is
* provided, one will be created below the

68
js/jquery/jquery-ui-1.8.16.custom.js vendored
View File

@ -8374,7 +8374,7 @@ $.extend(Datepicker.prototype, {
},
/* Override the default settings for all instances of the date picker.
@param settings object - the new settings to use as defaults (anonymous object)
@param settings object - the new settings to use as defaults (anonymous object)
@return the manager object */
setDefaults: function(settings) {
extendRemove(this._defaults, settings || {});
@ -8382,8 +8382,8 @@ $.extend(Datepicker.prototype, {
},
/* Attach the date picker to a jQuery selection.
@param target element - the target input field or division or span
@param settings object - the new settings to use for this date picker instance (anonymous) */
@param target element - the target input field or division or span
@param settings object - the new settings to use for this date picker instance (anonymous) */
_attachDatepicker: function(target, settings) {
// check for settings on the control itself - in namespace 'date:'
var inlineSettings = null;
@ -8534,11 +8534,11 @@ $.extend(Datepicker.prototype, {
},
/* Pop-up the date picker in a "dialog" box.
@param input element - ignored
@param date string or Date - the initial date to display
@param onSelect function - the function to call when a date is selected
@param settings object - update the dialog date picker instance's settings (anonymous object)
@param pos int[2] - coordinates for the dialog's position within the screen or
@param input element - ignored
@param date string or Date - the initial date to display
@param onSelect function - the function to call when a date is selected
@param settings object - update the dialog date picker instance's settings (anonymous object)
@param pos int[2] - coordinates for the dialog's position within the screen or
event - with x/y coordinates or
leave empty for default (screen centre)
@return the manager object */
@ -8582,7 +8582,7 @@ $.extend(Datepicker.prototype, {
},
/* Detach a datepicker from its control.
@param target element - the target input field or division or span */
@param target element - the target input field or division or span */
_destroyDatepicker: function(target) {
var $target = $(target);
var inst = $.data(target, PROP_NAME);
@ -8604,7 +8604,7 @@ $.extend(Datepicker.prototype, {
},
/* Enable the date picker to a jQuery selection.
@param target element - the target input field or division or span */
@param target element - the target input field or division or span */
_enableDatepicker: function(target) {
var $target = $(target);
var inst = $.data(target, PROP_NAME);
@ -8629,7 +8629,7 @@ $.extend(Datepicker.prototype, {
},
/* Disable the date picker to a jQuery selection.
@param target element - the target input field or division or span */
@param target element - the target input field or division or span */
_disableDatepicker: function(target) {
var $target = $(target);
var inst = $.data(target, PROP_NAME);
@ -8655,7 +8655,7 @@ $.extend(Datepicker.prototype, {
},
/* Is the first field in a jQuery collection disabled as a datepicker?
@param target element - the target input field or division or span
@param target element - the target input field or division or span
@return boolean - true if disabled, false if enabled */
_isDisabledDatepicker: function(target) {
if (!target) {
@ -8669,7 +8669,7 @@ $.extend(Datepicker.prototype, {
},
/* Retrieve the instance data for the target control.
@param target element - the target input field or division or span
@param target element - the target input field or division or span
@return object - the associated instance data
@throws error if a jQuery problem getting data */
_getInst: function(target) {
@ -8682,12 +8682,12 @@ $.extend(Datepicker.prototype, {
},
/* Update or retrieve the settings for a date picker attached to an input field or division.
@param target element - the target input field or division or span
@param name object - the new settings to update or
@param target element - the target input field or division or span
@param name object - the new settings to update or
string - the name of the setting to change or retrieve,
when retrieving also 'all' for all instance settings or
'defaults' for all global defaults
@param value any - the new value for the setting
@param value any - the new value for the setting
(omit if above is an object or to retrieve a value) */
_optionDatepicker: function(target, name, value) {
var inst = this._getInst(target);
@ -8728,7 +8728,7 @@ $.extend(Datepicker.prototype, {
},
/* Redraw the date picker attached to an input field or division.
@param target element - the target input field or division or span */
@param target element - the target input field or division or span */
_refreshDatepicker: function(target) {
var inst = this._getInst(target);
if (inst) {
@ -8737,8 +8737,8 @@ $.extend(Datepicker.prototype, {
},
/* Set the dates for a jQuery selection.
@param target element - the target input field or division or span
@param date Date - the new date */
@param target element - the target input field or division or span
@param date Date - the new date */
_setDateDatepicker: function(target, date) {
var inst = this._getInst(target);
if (inst) {
@ -8749,8 +8749,8 @@ $.extend(Datepicker.prototype, {
},
/* Get the date(s) for the first entry in a jQuery selection.
@param target element - the target input field or division or span
@param noDefault boolean - true if no default date is to be used
@param target element - the target input field or division or span
@param noDefault boolean - true if no default date is to be used
@return Date - the current date */
_getDateDatepicker: function(target, noDefault) {
var inst = this._getInst(target);
@ -8869,7 +8869,7 @@ $.extend(Datepicker.prototype, {
/* Pop-up the date picker for a given input field.
If false returned from beforeShow event handler do not show.
@param input element - the input field attached to the date picker or
@param input element - the input field attached to the date picker or
event - if triggered by focus */
_showDatepicker: function(input) {
input = input.target || input;
@ -8988,7 +8988,7 @@ $.extend(Datepicker.prototype, {
},
/* Retrieve the size of left and top borders for an element.
@param elem (jQuery object) the element of interest
@param elem (jQuery object) the element of interest
@return (number[2]) the left and top borders */
_getBorders: function(elem) {
var convert = function(value) {
@ -9040,7 +9040,7 @@ $.extend(Datepicker.prototype, {
},
/* Hide the date picker from view.
@param input element - the input field attached to the date picker */
@param input element - the input field attached to the date picker */
_hideDatepicker: function(input) {
var inst = this._curInst;
if (!inst || (input && inst != $.data(input, PROP_NAME)))
@ -9191,7 +9191,7 @@ $.extend(Datepicker.prototype, {
},
/* Set as beforeShowDay function to prevent selection of weekends.
@param date Date - the date to customise
@param date Date - the date to customise
@return [boolean, string] - is this date selectable?, what is its CSS class? */
noWeekends: function(date) {
var day = date.getDay();
@ -9199,7 +9199,7 @@ $.extend(Datepicker.prototype, {
},
/* Set as calculateWeek to determine the week of the year based on the ISO 8601 definition.
@param date Date - the date to get the week for
@param date Date - the date to get the week for
@return number - the number of the week within the year that contains this date */
iso8601Week: function(date) {
var checkDate = new Date(date.getTime());
@ -9214,9 +9214,9 @@ $.extend(Datepicker.prototype, {
/* Parse a string value into a date object.
See formatDate below for the possible formats.
@param format string - the expected format of the date
@param value string - the date in the above format
@param settings Object - attributes include:
@param format string - the expected format of the date
@param value string - the date in the above format
@param settings Object - attributes include:
shortYearCutoff number - the cutoff year for determining the century (optional)
dayNamesShort string[7] - abbreviated names of the days from Sunday (optional)
dayNames string[7] - names of the days from Sunday (optional)
@ -9397,9 +9397,9 @@ $.extend(Datepicker.prototype, {
'...' - literal text
'' - single quote
@param format string - the desired format of the date
@param date Date - the date value to format
@param settings Object - attributes include:
@param format string - the desired format of the date
@param date Date - the date value to format
@param settings Object - attributes include:
dayNamesShort string[7] - abbreviated names of the days from Sunday (optional)
dayNames string[7] - names of the days from Sunday (optional)
monthNamesShort string[12] - abbreviated names of the months (optional)
@ -9611,7 +9611,7 @@ $.extend(Datepicker.prototype, {
Hours may be non-zero on daylight saving cut-over:
> 12 when midnight changeover, but then cannot generate
midnight datetime, so jump to 1AM, otherwise reset.
@param date (Date) the date to check
@param date (Date) the date to check
@return (Date) the corrected date */
_daylightSavingAdjust: function(date) {
if (!date) return null;
@ -10022,7 +10022,7 @@ function isArray(a) {
};
/* Invoke the datepicker functionality.
@param options string - a command, optionally followed by additional parameters or
@param options string - a command, optionally followed by additional parameters or
Object - settings for attaching new datepicker functionality
@return jQuery object */
$.fn.datepicker = function(options){

414
js/jquery/jquery.svg.js
View File

@ -24,7 +24,7 @@ function SVGManager() {
}
/* Determine whether a given ActiveX control is available.
@param classId (string) the ID for the ActiveX control
@param classId (string) the ID for the ActiveX control
@return (boolean) true if found, false if not */
function detectActiveX(classId) {
try {
@ -166,7 +166,7 @@ $.extend(SVGManager.prototype, {
},
/* Return the SVG wrapper created for a given container.
@param container (string) selector for the container or
@param container (string) selector for the container or
(element) the container for the SVG object or
jQuery collection - first entry is the container
@return (SVGWrapper) the corresponding SVG wrapper element, or null if not attached */
@ -177,7 +177,7 @@ $.extend(SVGManager.prototype, {
},
/* Remove the SVG functionality from a div.
@param container (element) the container for the SVG object */
@param container (element) the container for the SVG object */
_destroySVG: function(container) {
var $container = $(container);
if (!$container.hasClass(this.markerClassName)) {
@ -194,8 +194,8 @@ $.extend(SVGManager.prototype, {
The constructor function must take a single parameter that is
a reference to the owning SVG root object. This allows the
extension to access the basic SVG functionality.
@param name (string) the name of the SVGWrapper attribute to access the new class
@param extClass (function) the extension class constructor */
@param name (string) the name of the SVGWrapper attribute to access the new class
@param extClass (function) the extension class constructor */
addExtension: function(name, extClass) {
this._extensions.push([name, extClass]);
}
@ -231,8 +231,8 @@ $.extend(SVGWrapper.prototype, {
},
/* Configure the SVG root.
@param settings (object) additional settings for the root
@param clear (boolean) true to remove existing attributes first,
@param settings (object) additional settings for the root
@param clear (boolean) true to remove existing attributes first,
false to add to what is already there (optional)
@return (SVGWrapper) this root */
configure: function(settings, clear) {
@ -252,15 +252,15 @@ $.extend(SVGWrapper.prototype, {
},
/* Locate a specific element in the SVG document.
@param id (string) the element's identifier
@param id (string) the element's identifier
@return (element) the element reference, or null if not found */
getElementById: function(id) {
return this._svg.ownerDocument.getElementById(id);
},
/* Change the attributes for a SVG node.
@param element (SVG element) the node to change
@param settings (object) the new settings
@param element (SVG element) the node to change
@param settings (object) the new settings
@return (SVGWrapper) this root */
change: function(element, settings) {
if (element) {
@ -304,9 +304,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a title.
@param parent (element or jQuery) the parent node for the new title (optional)
@param text (string) the text of the title
@param settings (object) additional settings for the title (optional)
@param parent (element or jQuery) the parent node for the new title (optional)
@param text (string) the text of the title
@param settings (object) additional settings for the title (optional)
@return (element) the new title node */
title: function(parent, text, settings) {
var args = this._args(arguments, ['text']);
@ -316,9 +316,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a description.
@param parent (element or jQuery) the parent node for the new description (optional)
@param text (string) the text of the description
@param settings (object) additional settings for the description (optional)
@param parent (element or jQuery) the parent node for the new description (optional)
@param text (string) the text of the description
@param settings (object) additional settings for the description (optional)
@return (element) the new description node */
describe: function(parent, text, settings) {
var args = this._args(arguments, ['text']);
@ -328,9 +328,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a definitions node.
@param parent (element or jQuery) the parent node for the new definitions (optional)
@param id (string) the ID of this definitions (optional)
@param settings (object) additional settings for the definitions (optional)
@param parent (element or jQuery) the parent node for the new definitions (optional)
@param id (string) the ID of this definitions (optional)
@param settings (object) additional settings for the definitions (optional)
@return (element) the new definitions node */
defs: function(parent, id, settings) {
var args = this._args(arguments, ['id'], ['id']);
@ -339,13 +339,13 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a symbol definition.
@param parent (element or jQuery) the parent node for the new symbol (optional)
@param id (string) the ID of this symbol
@param x1 (number) the left coordinate for this symbol
@param y1 (number) the top coordinate for this symbol
@param width (number) the width of this symbol
@param height (number) the height of this symbol
@param settings (object) additional settings for the symbol (optional)
@param parent (element or jQuery) the parent node for the new symbol (optional)
@param id (string) the ID of this symbol
@param x1 (number) the left coordinate for this symbol
@param y1 (number) the top coordinate for this symbol
@param width (number) the width of this symbol
@param height (number) the height of this symbol
@param settings (object) additional settings for the symbol (optional)
@return (element) the new symbol node */
symbol: function(parent, id, x1, y1, width, height, settings) {
var args = this._args(arguments, ['id', 'x1', 'y1', 'width', 'height']);
@ -355,14 +355,14 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a marker definition.
@param parent (element or jQuery) the parent node for the new marker (optional)
@param id (string) the ID of this marker
@param refX (number) the x-coordinate for the reference point
@param refY (number) the y-coordinate for the reference point
@param mWidth (number) the marker viewport width
@param mHeight (number) the marker viewport height
@param orient (string or int) 'auto' or angle (degrees) (optional)
@param settings (object) additional settings for the marker (optional)
@param parent (element or jQuery) the parent node for the new marker (optional)
@param id (string) the ID of this marker
@param refX (number) the x-coordinate for the reference point
@param refY (number) the y-coordinate for the reference point
@param mWidth (number) the marker viewport width
@param mHeight (number) the marker viewport height
@param orient (string or int) 'auto' or angle (degrees) (optional)
@param settings (object) additional settings for the marker (optional)
@return (element) the new marker node */
marker: function(parent, id, refX, refY, mWidth, mHeight, orient, settings) {
var args = this._args(arguments, ['id', 'refX', 'refY',
@ -373,9 +373,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a style node.
@param parent (element or jQuery) the parent node for the new node (optional)
@param styles (string) the CSS styles
@param settings (object) additional settings for the node (optional)
@param parent (element or jQuery) the parent node for the new node (optional)
@param styles (string) the CSS styles
@param settings (object) additional settings for the node (optional)
@return (element) the new style node */
style: function(parent, styles, settings) {
var args = this._args(arguments, ['styles']);
@ -389,10 +389,10 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a script node.
@param parent (element or jQuery) the parent node for the new node (optional)
@param script (string) the JavaScript code
@param type (string) the MIME type for the code (optional, default 'text/javascript')
@param settings (object) additional settings for the node (optional)
@param parent (element or jQuery) the parent node for the new node (optional)
@param script (string) the JavaScript code
@param type (string) the MIME type for the code (optional, default 'text/javascript')
@param settings (object) additional settings for the node (optional)
@return (element) the new script node */
script: function(parent, script, type, settings) {
var args = this._args(arguments, ['script', 'type'], ['type']);
@ -407,16 +407,16 @@ $.extend(SVGWrapper.prototype, {
/* Add a linear gradient definition.
Specify all of x1, y1, x2, y2 or none of them.
@param parent (element or jQuery) the parent node for the new gradient (optional)
@param id (string) the ID for this gradient
@param stops (string[][]) the gradient stops, each entry is
@param parent (element or jQuery) the parent node for the new gradient (optional)
@param id (string) the ID for this gradient
@param stops (string[][]) the gradient stops, each entry is
[0] is offset (0.0-1.0 or 0%-100%), [1] is colour,
[2] is opacity (optional)
@param x1 (number) the x-coordinate of the gradient start (optional)
@param y1 (number) the y-coordinate of the gradient start (optional)
@param x2 (number) the x-coordinate of the gradient end (optional)
@param y2 (number) the y-coordinate of the gradient end (optional)
@param settings (object) additional settings for the gradient (optional)
@param x1 (number) the x-coordinate of the gradient start (optional)
@param y1 (number) the y-coordinate of the gradient start (optional)
@param x2 (number) the x-coordinate of the gradient end (optional)
@param y2 (number) the y-coordinate of the gradient end (optional)
@param settings (object) additional settings for the gradient (optional)
@return (element) the new gradient node */
linearGradient: function(parent, id, stops, x1, y1, x2, y2, settings) {
var args = this._args(arguments,
@ -429,16 +429,16 @@ $.extend(SVGWrapper.prototype, {
/* Add a radial gradient definition.
Specify all of cx, cy, r, fx, fy or none of them.
@param parent (element or jQuery) the parent node for the new gradient (optional)
@param id (string) the ID for this gradient
@param stops (string[][]) the gradient stops, each entry
@param parent (element or jQuery) the parent node for the new gradient (optional)
@param id (string) the ID for this gradient
@param stops (string[][]) the gradient stops, each entry
[0] is offset, [1] is colour, [2] is opacity (optional)
@param cx (number) the x-coordinate of the largest circle centre (optional)
@param cy (number) the y-coordinate of the largest circle centre (optional)
@param r (number) the radius of the largest circle (optional)
@param fx (number) the x-coordinate of the gradient focus (optional)
@param fy (number) the y-coordinate of the gradient focus (optional)
@param settings (object) additional settings for the gradient (optional)
@param cx (number) the x-coordinate of the largest circle centre (optional)
@param cy (number) the y-coordinate of the largest circle centre (optional)
@param r (number) the radius of the largest circle (optional)
@param fx (number) the x-coordinate of the gradient focus (optional)
@param fy (number) the y-coordinate of the gradient focus (optional)
@param settings (object) additional settings for the gradient (optional)
@return (element) the new gradient node */
radialGradient: function(parent, id, stops, cx, cy, r, fx, fy, settings) {
var args = this._args(arguments,
@ -463,17 +463,17 @@ $.extend(SVGWrapper.prototype, {
/* Add a pattern definition.
Specify all of vx, vy, xwidth, vheight or none of them.
@param parent (element or jQuery) the parent node for the new pattern (optional)
@param id (string) the ID for this pattern
@param x (number) the x-coordinate for the left edge of the pattern
@param y (number) the y-coordinate for the top edge of the pattern
@param width (number) the width of the pattern
@param height (number) the height of the pattern
@param vx (number) the minimum x-coordinate for view box (optional)
@param vy (number) the minimum y-coordinate for the view box (optional)
@param vwidth (number) the width of the view box (optional)
@param vheight (number) the height of the view box (optional)
@param settings (object) additional settings for the pattern (optional)
@param parent (element or jQuery) the parent node for the new pattern (optional)
@param id (string) the ID for this pattern
@param x (number) the x-coordinate for the left edge of the pattern
@param y (number) the y-coordinate for the top edge of the pattern
@param width (number) the width of the pattern
@param height (number) the height of the pattern
@param vx (number) the minimum x-coordinate for view box (optional)
@param vy (number) the minimum y-coordinate for the view box (optional)
@param vwidth (number) the width of the view box (optional)
@param vheight (number) the height of the view box (optional)
@param settings (object) additional settings for the pattern (optional)
@return (element) the new pattern node */
pattern: function(parent, id, x, y, width, height, vx, vy, vwidth, vheight, settings) {
var args = this._args(arguments, ['id', 'x', 'y', 'width', 'height',
@ -485,13 +485,13 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a mask definition.
@param parent (element or jQuery) the parent node for the new mask (optional)
@param id (string) the ID for this mask
@param x (number) the x-coordinate for the left edge of the mask
@param y (number) the y-coordinate for the top edge of the mask
@param width (number) the width of the mask
@param height (number) the height of the mask
@param settings (object) additional settings for the mask (optional)
@param parent (element or jQuery) the parent node for the new mask (optional)
@param id (string) the ID for this mask
@param x (number) the x-coordinate for the left edge of the mask
@param y (number) the y-coordinate for the top edge of the mask
@param width (number) the width of the mask
@param height (number) the height of the mask
@param settings (object) additional settings for the mask (optional)
@return (element) the new mask node */
mask: function(parent, id, x, y, width, height, settings) {
var args = this._args(arguments, ['id', 'x', 'y', 'width', 'height']);
@ -514,16 +514,16 @@ $.extend(SVGWrapper.prototype, {
/* Add an embedded SVG element.
Specify all of vx, vy, vwidth, vheight or none of them.
@param parent (element or jQuery) the parent node for the new node (optional)
@param x (number) the x-coordinate for the left edge of the node
@param y (number) the y-coordinate for the top edge of the node
@param width (number) the width of the node
@param height (number) the height of the node
@param vx (number) the minimum x-coordinate for view box (optional)
@param vy (number) the minimum y-coordinate for the view box (optional)
@param vwidth (number) the width of the view box (optional)
@param vheight (number) the height of the view box (optional)
@param settings (object) additional settings for the node (optional)
@param parent (element or jQuery) the parent node for the new node (optional)
@param x (number) the x-coordinate for the left edge of the node
@param y (number) the y-coordinate for the top edge of the node
@param width (number) the width of the node
@param height (number) the height of the node
@param vx (number) the minimum x-coordinate for view box (optional)
@param vy (number) the minimum y-coordinate for the view box (optional)
@param vwidth (number) the width of the view box (optional)
@param vheight (number) the height of the view box (optional)
@param settings (object) additional settings for the node (optional)
@return (element) the new node */
svg: function(parent, x, y, width, height, vx, vy, vwidth, vheight, settings) {
var args = this._args(arguments, ['x', 'y', 'width', 'height',
@ -535,9 +535,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Create a group.
@param parent (element or jQuery) the parent node for the new group (optional)
@param id (string) the ID of this group (optional)
@param settings (object) additional settings for the group (optional)
@param parent (element or jQuery) the parent node for the new group (optional)
@param id (string) the ID of this group (optional)
@param settings (object) additional settings for the group (optional)
@return (element) the new group node */
group: function(parent, id, settings) {
var args = this._args(arguments, ['id'], ['id']);
@ -546,13 +546,13 @@ $.extend(SVGWrapper.prototype, {
/* Add a usage reference.
Specify all of x, y, width, height or none of them.
@param parent (element or jQuery) the parent node for the new node (optional)
@param x (number) the x-coordinate for the left edge of the node (optional)
@param y (number) the y-coordinate for the top edge of the node (optional)
@param width (number) the width of the node (optional)
@param height (number) the height of the node (optional)
@param ref (string) the ID of the definition node
@param settings (object) additional settings for the node (optional)
@param parent (element or jQuery) the parent node for the new node (optional)
@param x (number) the x-coordinate for the left edge of the node (optional)
@param y (number) the y-coordinate for the top edge of the node (optional)
@param width (number) the width of the node (optional)
@param height (number) the height of the node (optional)
@param ref (string) the ID of the definition node
@param settings (object) additional settings for the node (optional)
@return (element) the new node */
use: function(parent, x, y, width, height, ref, settings) {
var args = this._args(arguments, ['x', 'y', 'width', 'height', 'ref']);
@ -569,9 +569,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a link, which applies to all child elements.
@param parent (element or jQuery) the parent node for the new link (optional)
@param ref (string) the target URL
@param settings (object) additional settings for the link (optional)
@param parent (element or jQuery) the parent node for the new link (optional)
@param ref (string) the target URL
@param settings (object) additional settings for the link (optional)
@return (element) the new link node */
link: function(parent, ref, settings) {
var args = this._args(arguments, ['ref']);
@ -581,13 +581,13 @@ $.extend(SVGWrapper.prototype, {
},
/* Add an image.
@param parent (element or jQuery) the parent node for the new image (optional)
@param x (number) the x-coordinate for the left edge of the image
@param y (number) the y-coordinate for the top edge of the image
@param width (number) the width of the image
@param height (number) the height of the image
@param ref (string) the path to the image
@param settings (object) additional settings for the image (optional)
@param parent (element or jQuery) the parent node for the new image (optional)
@param x (number) the x-coordinate for the left edge of the image
@param y (number) the y-coordinate for the top edge of the image
@param width (number) the width of the image
@param height (number) the height of the image
@param ref (string) the path to the image
@param settings (object) additional settings for the image (optional)
@return (element) the new image node */
image: function(parent, x, y, width, height, ref, settings) {
var args = this._args(arguments, ['x', 'y', 'width', 'height', 'ref']);
@ -599,9 +599,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw a path.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param path (string or SVGPath) the path to draw
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param path (string or SVGPath) the path to draw
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
path: function(parent, path, settings) {
var args = this._args(arguments, ['path']);
@ -611,14 +611,14 @@ $.extend(SVGWrapper.prototype, {
/* Draw a rectangle.
Specify both of rx and ry or neither.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param x (number) the x-coordinate for the left edge of the rectangle
@param y (number) the y-coordinate for the top edge of the rectangle
@param width (number) the width of the rectangle
@param height (number) the height of the rectangle
@param rx (number) the x-radius of the ellipse for the rounded corners (optional)
@param ry (number) the y-radius of the ellipse for the rounded corners (optional)
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param x (number) the x-coordinate for the left edge of the rectangle
@param y (number) the y-coordinate for the top edge of the rectangle
@param width (number) the width of the rectangle
@param height (number) the height of the rectangle
@param rx (number) the x-radius of the ellipse for the rounded corners (optional)
@param ry (number) the y-radius of the ellipse for the rounded corners (optional)
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
rect: function(parent, x, y, width, height, rx, ry, settings) {
var args = this._args(arguments, ['x', 'y', 'width', 'height', 'rx', 'ry'], ['rx']);
@ -628,11 +628,11 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw a circle.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param cx (number) the x-coordinate for the centre of the circle
@param cy (number) the y-coordinate for the centre of the circle
@param r (number) the radius of the circle
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param cx (number) the x-coordinate for the centre of the circle
@param cy (number) the y-coordinate for the centre of the circle
@param r (number) the radius of the circle
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
circle: function(parent, cx, cy, r, settings) {
var args = this._args(arguments, ['cx', 'cy', 'r']);
@ -641,12 +641,12 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw an ellipse.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param cx (number) the x-coordinate for the centre of the ellipse
@param cy (number) the y-coordinate for the centre of the ellipse
@param rx (number) the x-radius of the ellipse
@param ry (number) the y-radius of the ellipse
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param cx (number) the x-coordinate for the centre of the ellipse
@param cy (number) the y-coordinate for the centre of the ellipse
@param rx (number) the x-radius of the ellipse
@param ry (number) the y-radius of the ellipse
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
ellipse: function(parent, cx, cy, rx, ry, settings) {
var args = this._args(arguments, ['cx', 'cy', 'rx', 'ry']);
@ -655,12 +655,12 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw a line.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param x1 (number) the x-coordinate for the start of the line
@param y1 (number) the y-coordinate for the start of the line
@param x2 (number) the x-coordinate for the end of the line
@param y2 (number) the y-coordinate for the end of the line
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param x1 (number) the x-coordinate for the start of the line
@param y1 (number) the y-coordinate for the start of the line
@param x2 (number) the x-coordinate for the end of the line
@param y2 (number) the y-coordinate for the end of the line
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
line: function(parent, x1, y1, x2, y2, settings) {
var args = this._args(arguments, ['x1', 'y1', 'x2', 'y2']);
@ -669,9 +669,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw a polygonal line.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param points (number[][]) the x-/y-coordinates for the points on the line
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param points (number[][]) the x-/y-coordinates for the points on the line
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
polyline: function(parent, points, settings) {
var args = this._args(arguments, ['points']);
@ -679,9 +679,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw a polygonal shape.
@param parent (element or jQuery) the parent node for the new shape (optional)
@param points (number[][]) the x-/y-coordinates for the points on the shape
@param settings (object) additional settings for the shape (optional)
@param parent (element or jQuery) the parent node for the new shape (optional)
@param points (number[][]) the x-/y-coordinates for the points on the shape
@param settings (object) additional settings for the shape (optional)
@return (element) the new shape node */
polygon: function(parent, points, settings) {
var args = this._args(arguments, ['points']);
@ -700,12 +700,12 @@ $.extend(SVGWrapper.prototype, {
/* Draw text.
Specify both of x and y or neither of them.
@param parent (element or jQuery) the parent node for the text (optional)
@param x (number or number[]) the x-coordinate(s) for the text (optional)
@param y (number or number[]) the y-coordinate(s) for the text (optional)
@param value (string) the text content or
@param parent (element or jQuery) the parent node for the text (optional)
@param x (number or number[]) the x-coordinate(s) for the text (optional)
@param y (number or number[]) the y-coordinate(s) for the text (optional)
@param value (string) the text content or
(SVGText) text with spans and references
@param settings (object) additional settings for the text (optional)
@param settings (object) additional settings for the text (optional)
@return (element) the new text node */
text: function(parent, x, y, value, settings) {
var args = this._args(arguments, ['x', 'y', 'value']);
@ -721,11 +721,11 @@ $.extend(SVGWrapper.prototype, {
},
/* Draw text along a path.
@param parent (element or jQuery) the parent node for the text (optional)
@param path (string) the ID of the path
@param value (string) the text content or
@param parent (element or jQuery) the parent node for the text (optional)
@param path (string) the ID of the path
@param value (string) the text content or
(SVGText) text with spans and references
@param settings (object) additional settings for the text (optional)
@param settings (object) additional settings for the text (optional)
@return (element) the new text node */
textpath: function(parent, path, value, settings) {
var args = this._args(arguments, ['path', 'value']);
@ -770,9 +770,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Add a custom SVG element.
@param parent (element or jQuery) the parent node for the new element (optional)
@param name (string) the name of the element
@param settings (object) additional settings for the element (optional)
@param parent (element or jQuery) the parent node for the new element (optional)
@param name (string) the name of the element
@param settings (object) additional settings for the element (optional)
@return (element) the new custom node */
other: function(parent, name, settings) {
var args = this._args(arguments, ['name']);
@ -795,8 +795,8 @@ $.extend(SVGWrapper.prototype, {
},
/* Add an existing SVG node to the diagram.
@param parent (element or jQuery) the parent node for the new node (optional)
@param node (element) the new node to add or
@param parent (element or jQuery) the parent node for the new node (optional)
@param node (element) the new node to add or
(string) the jQuery selector for the node or
(jQuery collection) set of nodes to add
@return (SVGWrapper) this wrapper */
@ -874,9 +874,9 @@ $.extend(SVGWrapper.prototype, {
},
/* Load an external SVG document.
@param url (string) the location of the SVG document or
@param url (string) the location of the SVG document or
the actual SVG content
@param settings (boolean) see addTo below or
@param settings (boolean) see addTo below or
(function) see onLoad below or
(object) additional settings for the load with attributes below:
addTo (boolean) true to add to what's already there,
@ -976,7 +976,7 @@ $.extend(SVGWrapper.prototype, {
},
/* Delete a specified node.
@param node (element or jQuery) the drawing node to remove
@param node (element or jQuery) the drawing node to remove
@return (SVGWrapper) this root */
remove: function(node) {
node = (node.jquery ? node[0] : node);
@ -985,7 +985,7 @@ $.extend(SVGWrapper.prototype, {
},
/* Delete everything in the current document.
@param attrsToo (boolean) true to clear any root attributes as well,
@param attrsToo (boolean) true to clear any root attributes as well,
false to leave them (optional)
@return (SVGWrapper) this root */
clear: function(attrsToo) {
@ -999,7 +999,7 @@ $.extend(SVGWrapper.prototype, {
},
/* Serialise the current diagram into an SVG text document.
@param node (SVG element) the starting node (optional)
@param node (SVG element) the starting node (optional)
@return (string) the SVG as text */
toSVG: function(node) {
node = node || this._svg;
@ -1076,10 +1076,10 @@ $.extend(SVGPath.prototype, {
},
/* Move the pointer to a position.
@param x (number) x-coordinate to move to or
@param x (number) x-coordinate to move to or
(number[][]) x-/y-coordinates to move to
@param y (number) y-coordinate to move to (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y (number) y-coordinate to move to (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
move: function(x, y, relative) {
@ -1088,10 +1088,10 @@ $.extend(SVGPath.prototype, {
},
/* Draw a line to a position.
@param x (number) x-coordinate to move to or
@param x (number) x-coordinate to move to or
(number[][]) x-/y-coordinates to move to
@param y (number) y-coordinate to move to (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y (number) y-coordinate to move to (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
line: function(x, y, relative) {
@ -1100,9 +1100,9 @@ $.extend(SVGPath.prototype, {
},
/* Draw a horizontal line to a position.
@param x (number) x-coordinate to draw to or
@param x (number) x-coordinate to draw to or
(number[]) x-coordinates to draw to
@param relative (boolean) true for coordinates relative to the current point,
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
horiz: function(x, relative) {
@ -1111,9 +1111,9 @@ $.extend(SVGPath.prototype, {
},
/* Draw a vertical line to a position.
@param y (number) y-coordinate to draw to or
@param y (number) y-coordinate to draw to or
(number[]) y-coordinates to draw to
@param relative (boolean) true for coordinates relative to the current point,
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
vert: function(y, relative) {
@ -1122,14 +1122,14 @@ $.extend(SVGPath.prototype, {
},
/* Draw a cubic Bézier curve.
@param x1 (number) x-coordinate of beginning control point or
@param x1 (number) x-coordinate of beginning control point or
(number[][]) x-/y-coordinates of control and end points to draw to
@param y1 (number) y-coordinate of beginning control point (omitted if x1 is array)
@param x2 (number) x-coordinate of ending control point (omitted if x1 is array)
@param y2 (number) y-coordinate of ending control point (omitted if x1 is array)
@param x (number) x-coordinate of curve end (omitted if x1 is array)
@param y (number) y-coordinate of curve end (omitted if x1 is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y1 (number) y-coordinate of beginning control point (omitted if x1 is array)
@param x2 (number) x-coordinate of ending control point (omitted if x1 is array)
@param y2 (number) y-coordinate of ending control point (omitted if x1 is array)
@param x (number) x-coordinate of curve end (omitted if x1 is array)
@param y (number) y-coordinate of curve end (omitted if x1 is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
curveC: function(x1, y1, x2, y2, x, y, relative) {
@ -1139,12 +1139,12 @@ $.extend(SVGPath.prototype, {
/* Continue a cubic Bézier curve.
Starting control point is the reflection of the previous end control point.
@param x2 (number) x-coordinate of ending control point or
@param x2 (number) x-coordinate of ending control point or
(number[][]) x-/y-coordinates of control and end points to draw to
@param y2 (number) y-coordinate of ending control point (omitted if x2 is array)
@param x (number) x-coordinate of curve end (omitted if x2 is array)
@param y (number) y-coordinate of curve end (omitted if x2 is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y2 (number) y-coordinate of ending control point (omitted if x2 is array)
@param x (number) x-coordinate of curve end (omitted if x2 is array)
@param y (number) y-coordinate of curve end (omitted if x2 is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
smoothC: function(x2, y2, x, y, relative) {
@ -1153,12 +1153,12 @@ $.extend(SVGPath.prototype, {
},
/* Draw a quadratic Bézier curve.
@param x1 (number) x-coordinate of control point or
@param x1 (number) x-coordinate of control point or
(number[][]) x-/y-coordinates of control and end points to draw to
@param y1 (number) y-coordinate of control point (omitted if x1 is array)
@param x (number) x-coordinate of curve end (omitted if x1 is array)
@param y (number) y-coordinate of curve end (omitted if x1 is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y1 (number) y-coordinate of control point (omitted if x1 is array)
@param x (number) x-coordinate of curve end (omitted if x1 is array)
@param y (number) y-coordinate of curve end (omitted if x1 is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
curveQ: function(x1, y1, x, y, relative) {
@ -1168,10 +1168,10 @@ $.extend(SVGPath.prototype, {
/* Continue a quadratic Bézier curve.
Control point is the reflection of the previous control point.
@param x (number) x-coordinate of curve end or
@param x (number) x-coordinate of curve end or
(number[][]) x-/y-coordinates of points to draw to
@param y (number) y-coordinate of curve end (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
@param y (number) y-coordinate of curve end (omitted if x is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
smoothQ: function(x, y, relative) {
@ -1198,17 +1198,17 @@ $.extend(SVGPath.prototype, {
},
/* Draw an arc to a position.
@param rx (number) x-radius of arc or
@param rx (number) x-radius of arc or
(number/boolean[][]) x-/y-coordinates and flags for points to draw to
@param ry (number) y-radius of arc (omitted if rx is array)
@param xRotate (number) x-axis rotation (degrees, clockwise) (omitted if rx is array)
@param large (boolean) true to draw the large part of the arc,
@param ry (number) y-radius of arc (omitted if rx is array)
@param xRotate (number) x-axis rotation (degrees, clockwise) (omitted if rx is array)
@param large (boolean) true to draw the large part of the arc,
false to draw the small part (omitted if rx is array)
@param clockwise (boolean) true to draw the clockwise arc,
@param clockwise (boolean) true to draw the clockwise arc,
false to draw the anti-clockwise arc (omitted if rx is array)
@param x (number) x-coordinate of arc end (omitted if rx is array)
@param y (number) y-coordinate of arc end (omitted if rx is array)
@param relative (boolean) true for coordinates relative to the current point,
@param x (number) x-coordinate of arc end (omitted if rx is array)
@param y (number) y-coordinate of arc end (omitted if rx is array)
@param relative (boolean) true for coordinates relative to the current point,
false for coordinates being absolute
@return (SVGPath) this path */
arc: function(rx, ry, xRotate, large, clockwise, x, y, relative) {
@ -1272,7 +1272,7 @@ $.extend(SVGText.prototype, {
},
/* Add a straight string value.
@param value (string) the actual text
@param value (string) the actual text
@return (SVGText) this text object */
string: function(value) {
this._parts[this._parts.length] = ['text', value];
@ -1280,8 +1280,8 @@ $.extend(SVGText.prototype, {
},
/* Add a separate text span that has its own settings.
@param value (string) the actual text
@param settings (object) the settings for this text
@param value (string) the actual text
@param settings (object) the settings for this text
@return (SVGText) this text object */
span: function(value, settings) {
this._parts[this._parts.length] = ['tspan', value, settings];
@ -1289,8 +1289,8 @@ $.extend(SVGText.prototype, {
},
/* Add a reference to a previously defined text string.
@param id (string) the ID of the actual text
@param settings (object) the settings for this text
@param id (string) the ID of the actual text
@param settings (object) the settings for this text
@return (SVGText) this text object */
ref: function(id, settings) {
this._parts[this._parts.length] = ['tref', id, settings];
@ -1298,9 +1298,9 @@ $.extend(SVGText.prototype, {
},
/* Add text drawn along a path.
@param id (string) the ID of the path
@param value (string) the actual text
@param settings (object) the settings for this text
@param id (string) the ID of the path
@param value (string) the actual text
@param settings (object) the settings for this text
@return (SVGText) this text object */
path: function(id, value, settings) {
this._parts[this._parts.length] = ['textpath', value,
@ -1310,8 +1310,8 @@ $.extend(SVGText.prototype, {
});
/* Attach the SVG functionality to a jQuery selection.
@param command (string) the command to run (optional, default 'attach')
@param options (object) the new settings to use for these SVG instances
@param command (string) the command to run (optional, default 'attach')
@param options (object) the new settings to use for these SVG instances
@return jQuery (object) for chaining further calls */
$.fn.svg = function(options) {
var otherArgs = Array.prototype.slice.call(arguments, 1);

2
js/jquery/timepicker.js vendored
View File

@ -108,7 +108,7 @@ $.extend(Timepicker.prototype, {
"+0700", "+0800", "+0900", "+1000", "+1100", "+1200"],
/* Override the default settings for all instances of the time picker.
@param settings object - the new settings to use as defaults (anonymous object)
@param settings object - the new settings to use as defaults (anonymous object)
@return the manager object */
setDefaults: function(settings) {
extendRemove(this._defaults, settings || {});

2
js/keyhandler.js
View File

@ -2,7 +2,7 @@
/**
* Allows moving around inputs/select by Ctrl+arrows
*
* @param object event data
* @param object event data
*/
function onKeyDownArrowsHandler(e)
{

20
js/navigation.js
View File

@ -14,8 +14,8 @@ var pma_saveframesize_timeout = null;
/**
* opens/closes (hides/shows) tree elements
*
* @param string id id of the element in the DOM
* @param boolean only_open do not close/hide element
* @param string id id of the element in the DOM
* @param boolean only_open do not close/hide element
*/
function toggle(id, only_open)
{
@ -112,7 +112,7 @@ function PMA_setFrameSize()
/**
* retrieves a named value from cookie
*
* @param string name name of the value to retrieve
* @param string name name of the value to retrieve
* @return string value value for the given name from cookie
*/
function PMA_getCookie(name)
@ -135,12 +135,12 @@ function PMA_getCookie(name)
/**
* stores a named value into cookie
*
* @param string name name of value
* @param string value value to be stored
* @param Date expires expire time
* @param string path
* @param string domain
* @param boolean secure
* @param string name name of value
* @param string value value to be stored
* @param Date expires expire time
* @param string path
* @param string domain
* @param boolean secure
*/
function PMA_setCookie(name, value, expires, path, domain, secure)
{
@ -154,7 +154,7 @@ function PMA_setCookie(name, value, expires, path, domain, secure)
/**
* hide all LI elements with second A tag which doesn`t contain requested value
*
* @param string value requested value
* @param string value requested value
*
*/
function fast_filter(value)

10
js/rte/routines.js
View File

@ -10,7 +10,7 @@ RTE.param_template = '';
/**
* Overriding the postDialogShow() function defined in common.js
*
* @param data JSON-encoded data from the ajax request
* @param data JSON-encoded data from the ajax request
*/
RTE.postDialogShow = function (data) {
// Cache the template for a parameter table row
@ -121,14 +121,14 @@ RTE.validateCustom = function () {
* parameters and the return variable in the routine editor
* as necessary.
*
* @param $type a jQuery object containing the reference
* @param $type a jQuery object containing the reference
* to the "Type" dropdown box
* @param $len a jQuery object containing the reference
* @param $len a jQuery object containing the reference
* to the "Length" input box
* @param $text a jQuery object containing the reference
* @param $text a jQuery object containing the reference
* to the dropdown box with options for
* parameters of text type
* @param $num a jQuery object containing the reference
* @param $num a jQuery object containing the reference
* to the dropdown box with options for
* parameters of numeric type
*/

8
js/server_privileges.js
View File

@ -14,7 +14,7 @@
*
* @see PMA_messages['strPasswordEmpty']
* @see PMA_messages['strPasswordNotSame']
* @param object the form
* @param object the form
* @return boolean whether the field value is valid or not
*/
function checkPassword(the_form)
@ -77,9 +77,9 @@ function checkAddUser(the_form)
* When a new user is created and retrieved over Ajax, append the user's row to
* the user's table
*
* @param new_user_string the html for the new user's row
* @param new_user_initial the first alphabet of the user's name
* @param new_user_initial_string html to replace the initial for pagination
* @param new_user_string the html for the new user's row
* @param new_user_initial the first alphabet of the user's name
* @param new_user_initial_string html to replace the initial for pagination
*/
function appendNewUser(new_user_string, new_user_initial, new_user_initial_string)
{

20
js/server_synchronize.js
View File

@ -13,14 +13,14 @@ var row_class = 'even';
* rows to be updated, number of rows to be inserted, number of
* columns to be added, number of columns to be removed, etc.
*
* @param index index of matching table
* @param update_size number of rows/column to be updated
* @param insert_size number of rows/coulmns to be inserted
* @param remove_size number of columns to be removed
* @param insert_index number of indexes to be inserted
* @param remove_index number of indexes to be removed
* @param img_obj image object
* @param table_name name of the table
* @param index index of matching table
* @param update_size number of rows/column to be updated
* @param insert_size number of rows/coulmns to be inserted
* @param remove_size number of columns to be removed
* @param insert_index number of indexes to be inserted
* @param remove_index number of indexes to be removed
* @param img_obj image object
* @param table_name name of the table
*/
function showDetails(i, update_size, insert_size, remove_size, insert_index, remove_index, img_obj, table_name)
@ -221,7 +221,7 @@ function showDetails(i, update_size, insert_size, remove_size, insert_index, rem
* Generates the URL containing the list of selected table ids for synchronization and
* a variable checked for confirmation of deleting previous rows from target tables
*
* @param token the token generated for each PMA form
* @param token the token generated for each PMA form
*
*/
function ApplySelectedChanges(token)
@ -249,7 +249,7 @@ function ApplySelectedChanges(token)
/**
* Validates a partial form (source part or target part)
*
* @param which 'src' or 'trg'
* @param which 'src' or 'trg'
* @return boolean whether the partial form is valid
*
*/

2
js/sql.js
View File

@ -29,7 +29,7 @@ function PMA_urlencode(str)
* Get the field name for the current field. Required to construct the query
* for grid editing
*
* @param $this_field jQuery object that points to the current field's tr
* @param $this_field jQuery object that points to the current field's tr
*/
function getFieldName($this_field)
{

8
js/tbl_change.js
View File

@ -11,10 +11,10 @@
/**
* Modify form controls when the "NULL" checkbox is checked
*
* @param theType string the MySQL field type
* @param urlField string the urlencoded field name - OBSOLETE
* @param md5Field string the md5 hashed field name
* @param multi_edit string the multi_edit row sequence number
* @param theType string the MySQL field type
* @param urlField string the urlencoded field name - OBSOLETE
* @param md5Field string the md5 hashed field name
* @param multi_edit string the multi_edit row sequence number
*
* @return boolean always true
*/

4
js/tbl_structure.js
View File

@ -506,9 +506,9 @@ $(function() {
/**
* Loads the append_fields_form to the Change dialog allowing users
* to change the columns
* @param string action Variable which parses the name of the
* @param string action Variable which parses the name of the
* destination file
* @param string $url Variable which parses the data for the
* @param string $url Variable which parses the data for the
* post action
*/
function changeColumns(action,url)

8
libraries/auth/cookie.auth.lib.php
View File

@ -50,8 +50,8 @@ if (function_exists('mcrypt_encrypt')) {
/**
* Encryption using blowfish algorithm (mcrypt)
*
* @param string original data
* @param string the secret
* @param string original data
* @param string the secret
*
* @return string the encrypted result
*
@ -67,8 +67,8 @@ if (function_exists('mcrypt_encrypt')) {
/**
* Decryption using blowfish algorithm (mcrypt)
*
* @param string encrypted data
* @param string the secret
* @param string encrypted data
* @param string the secret
*
* @return string original data
*

20
libraries/auth/swekey/swekey.php
View File

@ -79,7 +79,7 @@ if (! isset($gSwekeyTokenCacheEnabled)) {
* Change the address of the Check server.
* If $server is empty the default value 'http://auth-check.musbe.net' will be used
*
* @param server The protocol and hostname to use
* @param server The protocol and hostname to use
* @access public
*/
function Swekey_SetCheckServer($server)
@ -96,7 +96,7 @@ function Swekey_SetCheckServer($server)
* Change the address of the Random Token Generator server.
* If $server is empty the default value 'http://auth-rnd-gen.musbe.net' will be used
*
* @param server The protocol and hostname to use
* @param server The protocol and hostname to use
* @access public
*/
function Swekey_SetRndTokenServer($server)
@ -113,7 +113,7 @@ function Swekey_SetRndTokenServer($server)
* Change the address of the Satus server.
* If $server is empty the default value 'http://auth-status.musbe.net' will be used
*
* @param server The protocol and hostname to use
* @param server The protocol and hostname to use
* @access public
*/
function Swekey_SetStatusServer($server)
@ -129,7 +129,7 @@ function Swekey_SetStatusServer($server)
/**
* Change the certificat file in case of the the severs use https instead of http
*
* @param cafile The path of the crt file to use
* @param cafile The path of the crt file to use
* @access public
*/
function Swekey_SetCAFile($cafile)
@ -143,7 +143,7 @@ function Swekey_SetCAFile($cafile)
* Because everybody has full access to the cache file, it can be a DOS vulnerability
* So disable it if you are running in a non secure enviromnement
*
* @param $enable
* @param $enable
* @access public
*/
function Swekey_EnableTokenCache($enable)
@ -181,8 +181,8 @@ function Swekey_GetLastResult()
* Send a synchronous request to the server.
* This function manages timeout then will not block if one of the server is down
*
* @param url The url to get
* @param response_code The response code
* @param url The url to get
* @param response_code The response code
* @return The body of the response or "" in case of error
* @access private
*/
@ -419,7 +419,7 @@ function Swekey_GetFastRndToken()
/**
* Checks that an OTP generated by a Swekey is valid
*
* @param id The id of the swekey
* @param id The id of the swekey
* @param rt The random token used to generate the otp
* @param otp The otp generated by the swekey
* @return true or false
@ -457,7 +457,7 @@ define("SWEKEY_STATUS_NOTPLUGGED", 200); // This key is not plugged in the compu
/**
* Return the text corresponding to the integer status of a key
*
* @param status The status
* @param status The status
* @return The text corresponding to the status
* @access public
*/
@ -495,7 +495,7 @@ function Swekey_GetStatusStr($status)
* If your web site requires a key to login you should check that the key
* is still valid (has not been lost or stolen) before requiring it.
* A key can be authenticated only if its status is SWEKEY_STATUS_OK
* @param id The id of the swekey
* @param id The id of the swekey
* @return The status of the swekey
* @access public
*/

16
libraries/config/ConfigFile.class.php
View File

@ -294,8 +294,8 @@ class ConfigFile
/**
* Returns config value or $default if it's not set
*
* @param string $path
* @param mixed $default
* @param string $path
* @param mixed $default
* @return mixed
*/
public function get($path, $default = null)
@ -308,8 +308,8 @@ class ConfigFile
* exist in config.default.php ($cfg) and config.values.php
* ($_cfg_db['_overrides'])
*
* @param string $canonical_path
* @param mixed $default
* @param string $canonical_path
* @param mixed $default
* @return mixed
*/
public function getDefault($canonical_path, $default = null)
@ -321,8 +321,8 @@ class ConfigFile
* Returns config value, if it's not set uses the default one; returns
* $default if the path isn't set and doesn't contain a default value
*
* @param string $path
* @param mixed $default
* @param string $path
* @param mixed $default
* @return mixed
*/
public function getValue($path, $default = null)
@ -349,8 +349,8 @@ class ConfigFile
/**
* Returns config database entry for $path ($cfg_db in config_info.php)
*
* @param string $path
* @param mixed $default
* @param string $path
* @param mixed $default
* @return mixed
*/
public function getDbEntry($path, $default = null)

10
libraries/config/Form.class.php
View File

@ -60,7 +60,7 @@ class Form
/**
* Returns type of given option
*
* @param string $option_name path or field name
* @param string $option_name path or field name
* @return string|null one of: boolean, integer, double, string, select, array
*/
public function getOptionType($option_name)
@ -74,7 +74,7 @@ class Form
/**
* Returns allowed values for select fields
*
* @param string $option_path
* @param string $option_path
* @return array
*/
public function getOptionValueList($option_path)
@ -116,9 +116,9 @@ class Form
* array_walk callback function, reads path of form fields from
* array (see file comment in setup.forms.php or user_preferences.forms.inc)
*
* @param mixed $value
* @param mixed $key
* @param mixed $prefix
* @param mixed $value
* @param mixed $key
* @param mixed $prefix
*/
private function _readFormPathsCallback($value, $key, $prefix)
{

12
libraries/config/FormDisplay.class.php
View File

@ -112,8 +112,8 @@ class FormDisplay
/**
* Processes forms, returns true on successful save
*
* @param bool $allow_partial_save allows for partial form saving on failed validation
* @param bool $check_form_submit whether check for $_POST['submit_save']
* @param bool $allow_partial_save allows for partial form saving on failed validation
* @param bool $check_form_submit whether check for $_POST['submit_save']
* @return boolean
*/
public function process($allow_partial_save = true, $check_form_submit = true)
@ -436,8 +436,8 @@ class FormDisplay
/**
* Validates select field and casts $value to correct type
*
* @param string $value
* @param array $allowed
* @param string $value
* @param array $allowed
* @return bool
*/
private function _validateSelect(&$value, array $allowed)
@ -464,8 +464,8 @@ class FormDisplay
/**
* Validates and saves form data to session
*
* @param array|string $forms array of form names
* @param bool $allow_partial_save allows for partial form saving on failed validation
* @param array|string $forms array of form names
* @param bool $allow_partial_save allows for partial form saving on failed validation
* @return boolean true on success (no errors and all saved)
*/
public function save($forms, $allow_partial_save = true)

4
libraries/config/config_functions.lib.php
View File

@ -11,8 +11,8 @@
* for formatting. Takes variable number of arguments.
* Based on PMA_sanitize from sanitize.lib.php.
*
* @param string $lang_key key in $GLOBALS WITHOUT 'strSetup' prefix
* @param mixed $args,... arguments for sprintf
* @param string $lang_key key in $GLOBALS WITHOUT 'strSetup' prefix
* @param mixed $args,... arguments for sprintf
* @return string
*/
function PMA_lang($lang_key, $args = null)

10
libraries/dbi/mysql.dbi.lib.php
View File

@ -24,11 +24,11 @@ if (! defined('PMA_MYSQL_CLIENT_API')) {
/**
* Helper function for connecting to the database server
*
* @param string $server
* @param string $user
* @param string $password
* @param int $client_flags
* @param bool $persistent
* @param string $server
* @param string $user
* @param string $password
* @param int $client_flags
* @param bool $persistent
* @return mixed false on error or a mysql connection resource on success
*/
function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persistent = false)

2
libraries/engines/innodb.lib.php
View File

@ -278,7 +278,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine
/**
* returns content for page $id
*
* @param string $id page id
* @param string $id page id
* @return string html output
*/
function getPage($id)

2
libraries/engines/pbxt.lib.php
View File

@ -88,7 +88,7 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine
* returns the pbxt engine specific handling for
* PMA_ENGINE_DETAILS_TYPE_SIZE variables.
*
* @param string $formatted_size the size expression (for example 8MB)
* @param string $formatted_size the size expression (for example 8MB)
*
* @return string the formatted value and its unit
*/

8
libraries/rte/rte_events.lib.php
View File

@ -261,7 +261,7 @@ function PMA_EVN_getDataFromRequest()
* This function will generate the values that are required to complete
* the "Edit event" form given the name of a event.
*
* @param string $name The name of the event.
* @param string $name The name of the event.
*
* @return array Data necessary to create the editor.
*/
@ -307,12 +307,12 @@ function PMA_EVN_getDataFromName($name)
/**
* Displays a form used to add/edit an event
*
* @param string $mode If the editor will be used edit an event
* @param string $mode If the editor will be used edit an event
* or add a new one: 'edit' or 'add'.
* @param string $operation If the editor was previously invoked with
* @param string $operation If the editor was previously invoked with
* JS turned off, this will hold the name of
* the current operation
* @param array $item Data for the event returned by
* @param array $item Data for the event returned by
* PMA_EVN_getDataFromRequest() or
* PMA_EVN_getDataFromName()
*

4
libraries/rte/rte_export.lib.php
View File

@ -13,8 +13,8 @@ if (! defined('PHPMYADMIN')) {
* This function is called from one of the other functions in this file
* and it completes the handling of the export functionality.
*
* @param string $item_name The name of the item that we are exporting
* @param string $export_data The SQL query to create the requested item
* @param string $item_name The name of the item that we are exporting
* @param string $export_data The SQL query to create the requested item
*/
function PMA_RTE_handleExport($item_name, $export_data)
{

6
libraries/rte/rte_footer.lib.php
View File

@ -12,9 +12,9 @@ if (! defined('PHPMYADMIN')) {
/**
* Creates a fieldset for adding a new item, if the user has the privileges.
*
* @param string $docu String used to create a link to the MySQL docs
* @param string $priv Privilege to check for adding a new item
* @param string $name MySQL name of the item
* @param string $docu String used to create a link to the MySQL docs
* @param string $priv Privilege to check for adding a new item
* @param string $name MySQL name of the item
*
* @return string An HTML snippet with the link to add a new item
*/

16
libraries/rte/rte_list.lib.php
View File

@ -13,8 +13,8 @@ if (! defined('PHPMYADMIN')) {
* Creates a list of items containing the relevant
* information and some action links.
*
* @param string $type One of ['routine'|'trigger'|'event']
* @param array $items An array of items
* @param string $type One of ['routine'|'trigger'|'event']
* @param array $items An array of items
*
* @return string HTML code of the list of items
*/
@ -121,8 +121,8 @@ function PMA_RTE_getList($type, $items)
/**
* Creates the contents for a row in the list of routines
*
* @param array $routine An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
* @param array $routine An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
*
* @return string HTML code of a row for the list of routines
*/
@ -230,8 +230,8 @@ function PMA_RTN_getRowForList($routine, $rowclass = '')
/**
* Creates the contents for a row in the list of triggers
*
* @param array $trigger An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
* @param array $trigger An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
*
* @return string HTML code of a cell for the list of triggers
*/
@ -299,8 +299,8 @@ function PMA_TRI_getRowForList($trigger, $rowclass = '')
/**
* Creates the contents for a row in the list of events
*
* @param array $event An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
* @param array $event An array of routine data
* @param string $rowclass Empty or one of ['even'|'odd']
*
* @return string HTML code of a cell for the list of events
*/

28
libraries/rte/rte_routines.lib.php
View File

@ -76,7 +76,7 @@ function PMA_RTN_main()
* as returned by PMA_RTN_parseAllParameters() and returns an array containing
* the information about this parameter.
*
* @param string $value A string containing one parameter of a routine
* @param string $value A string containing one parameter of a routine
*
* @return array Parsed information about the input parameter
*/
@ -135,8 +135,8 @@ function PMA_RTN_parseOneParameter($value)
* SHOW CREATE [PROCEDURE | FUNCTION] query and extracts
* information about the routine's parameters.
*
* @param array $parsed_query Parsed query, returned by by PMA_SQP_parse()
* @param string $routine_type Routine type: 'PROCEDURE' or 'FUNCTION'
* @param array $parsed_query Parsed query, returned by by PMA_SQP_parse()
* @param string $routine_type Routine type: 'PROCEDURE' or 'FUNCTION'
*
* @return array Information about the parameteres of a routine.
*/
@ -201,7 +201,7 @@ function PMA_RTN_parseAllParameters($parsed_query, $routine_type)
* SHOW CREATE [PROCEDURE | FUNCTION] query and extracts
* information about the routine's definer.
*
* @param array $parsed_query Parsed query, returned by PMA_SQP_parse()
* @param array $parsed_query Parsed query, returned by PMA_SQP_parse()
*
* @return string The definer of a routine.
*/
@ -500,9 +500,9 @@ function PMA_RTN_getDataFromRequest()
* This function will generate the values that are required to complete
* the "Edit routine" form given the name of a routine.
*
* @param string $name The name of the routine.
* @param string $type Type of routine (ROUTINE|PROCEDURE)
* @param bool $all Whether to return all data or just
* @param string $name The name of the routine.
* @param string $type Type of routine (ROUTINE|PROCEDURE)
* @param bool $all Whether to return all data or just
* the info about parameters.
*
* @return array Data necessary to create the routine editor.
@ -622,12 +622,12 @@ function PMA_RTN_getDataFromName($name, $type, $all = true)
/**
* Creates one row for the parameter table used in the routine editor.
*
* @param array $routine Data for the routine returned by
* @param array $routine Data for the routine returned by
* PMA_RTN_getDataFromRequest() or
* PMA_RTN_getDataFromName()
* @param mixed $index Either a numeric index of the row being processed
* @param mixed $index Either a numeric index of the row being processed
* or NULL to create a template row for AJAX request
* @param string $class Class used to hide the direction column, if the
* @param string $class Class used to hide the direction column, if the
* row is for a stored function.
*
* @return string HTML code of one row of parameter table for the editor.
@ -727,12 +727,12 @@ function PMA_RTN_getParameterRow($routine = array(), $index = null, $class = '')
/**
* Displays a form used to add/edit a routine
*
* @param string $mode If the editor will be used edit a routine
* @param string $mode If the editor will be used edit a routine
* or add a new one: 'edit' or 'add'.
* @param string $operation If the editor was previously invoked with
* @param string $operation If the editor was previously invoked with
* JS turned off, this will hold the name of
* the current operation
* @param array $routine Data for the routine returned by
* @param array $routine Data for the routine returned by
* PMA_RTN_getDataFromRequest() or
* PMA_RTN_getDataFromName()
*
@ -1331,7 +1331,7 @@ function PMA_RTN_handleExecute()
/**
* Creates the HTML code that shows the routine execution dialog.
*
* @param array $routine Data for the routine returned by
* @param array $routine Data for the routine returned by
* PMA_RTN_getDataFromName()
*
* @return string HTML code for the routine execution dialog.

6
libraries/rte/rte_triggers.lib.php
View File

@ -225,7 +225,7 @@ function PMA_TRI_getDataFromRequest()
* This function will generate the values that are required to complete
* the "Edit trigger" form given the name of a trigger.
*
* @param string $name The name of the trigger.
* @param string $name The name of the trigger.
*
* @return array Data necessary to create the editor.
*/
@ -259,9 +259,9 @@ function PMA_TRI_getDataFromName($name)
/**
* Displays a form used to add/edit a trigger
*
* @param string $mode If the editor will be used edit a trigger
* @param string $mode If the editor will be used edit a trigger
* or add a new one: 'edit' or 'add'.
* @param array $item Data for the trigger returned by
* @param array $item Data for the trigger returned by
* PMA_TRI_getDataFromRequest() or
* PMA_TRI_getDataFromName()
*

2
libraries/rte/rte_words.lib.php
View File

@ -8,7 +8,7 @@ if (! defined('PHPMYADMIN')) {
* This function is used to retreive some language strings that are used
* in functionalities that are common to routines, triggers and events.
*
* @param string $index The index of the string to get
* @param string $index The index of the string to get
*
* @return string The requested string or an empty string, if not available
*/

2
scripts/decode_bug.php
View File

@ -61,7 +61,7 @@
/**
* Display the decoded bug report in ASCII format
*
* @param string the text data
* @param string the text data
*
* @return string the text enclosed by "<pre>...</pre>" tags
*

28
user_password.php
View File

@ -68,8 +68,8 @@ require './libraries/footer.inc.php';
/**
* Send the message as an ajax request
*
* @param array $change_password_message
* @param string $sql_query
* @param array $change_password_message
* @param string $sql_query
* @return void
*/
function PMA_getChangePassMessage($change_password_message, $sql_query = '')
@ -112,9 +112,9 @@ function PMA_setChangePasswordMsg()
/**
* Change the password
*
* @param string $password
* @param string $message
* @param array $change_password_message
* @param string $password
* @param string $message
* @param array $change_password_message
* @return void
*/
function PMA_changePassword($password, $message, $change_password_message)
@ -148,10 +148,10 @@ function PMA_changePassHashingFunction()
/**
* Generate the error url and submit the query
*
* @param string $password
* @param array $_url_params
* @param string $sql_query
* @param string $hashing_function
* @param string $password
* @param array $_url_params
* @param string $sql_query
* @param string $hashing_function
* @return void
*/
function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_query, $hashing_function)
@ -165,8 +165,8 @@ function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_que
/**
* Change password authentication type
*
* @param array $_url_params
* @param string $password
* @param array $_url_params
* @param string $password
* @return array $_url_params
*/
function PMA_changePassAuthType($_url_params, $password)
@ -191,9 +191,9 @@ function PMA_changePassAuthType($_url_params, $password)
/**
* Display the page
*
* @param string $message
* @param string $sql_query
* @param array $_url_params
* @param string $message
* @param string $sql_query
* @param array $_url_params
* @return void
*/
function PMA_changePassDisplayPage($message, $sql_query, $_url_params)