diff options
| author | Michal Čihař <michal@cihar.com> | 2012-04-27 13:33:26 +0400 |
|---|---|---|
| committer | Michal Čihař <michal@cihar.com> | 2012-04-27 13:33:26 +0400 |
| commit | 397b6fd00e38929f66f5db95d8e0390b79336bdd (patch) | |
| tree | e365b39797cb747e10eb59690db41c79570d3ca1 | |
| parent | e6cca75875cf2dd08ab1cf51501ee01f505a54c4 (diff) | |
Cleanup spacing after @return
89 files changed, 506 insertions, 506 deletions
diff --git a/db_search.php b/db_search.php index 1eb59ac19e..0f5c090777 100644 --- a/db_search.php +++ b/db_search.php @@ -117,7 +117,7 @@ if (isset($_REQUEST['submit_search'])) { * (1 -> 1 word at least, 2 -> all words, * 3 -> exact string, 4 -> regexp) * - * @return array 3 SQL querys (for count, display and delete results) + * @return array 3 SQL querys (for count, display and delete results) * * @todo can we make use of fulltextsearch IN BOOLEAN MODE for this? * PMA_backquote diff --git a/js/functions.js b/js/functions.js index 03a0b54f17..c7d2414e09 100644 --- a/js/functions.js +++ b/js/functions.js @@ -74,7 +74,7 @@ function PMA_prepareForAjaxRequest($form) * * @param object the form that holds the password fields * - * @return boolean always true + * @return boolean always true */ function suggestPassword(passwd_form) { @@ -247,7 +247,7 @@ function selectContent( element, lock, only_once ) * @param object the link * @param object the sql query to submit * - * @return boolean whether to run the query or not + * @return boolean whether to run the query or not */ function confirmLink(theLink, theSqlQuery) { @@ -285,7 +285,7 @@ function confirmLink(theLink, theSqlQuery) * @param object the form * @param object the sql query textarea * - * @return boolean whether to run the query or not + * @return boolean whether to run the query or not * * @see checkSqlQuery() */ @@ -351,7 +351,7 @@ function confirmQuery(theForm1, sqlQuery1) * * @param object the form * - * @return boolean always false + * @return boolean always false * * @see confirmQuery() */ @@ -410,7 +410,7 @@ function checkSqlQuery(theForm) * @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 + * @return boolean whether the form field is empty or not */ function emptyCheckTheField(theForm, theFieldName) { @@ -426,7 +426,7 @@ function emptyCheckTheField(theForm, theFieldName) * @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 + * @return boolean whether the form field is empty or not */ function emptyFormElements(theForm, theFieldName) { @@ -446,7 +446,7 @@ function emptyFormElements(theForm, theFieldName) * @param integer the minimum authorized value * @param integer the maximum authorized value * - * @return boolean whether a valid number has been submitted or not + * @return boolean whether a valid number has been submitted or not */ function checkFormElementInRange(theForm, theFieldName, message, min, max) { @@ -700,7 +700,7 @@ function unMarkAllRows(container_id) * * @param string container_id the container id * @param boolean state new value for checkbox (true or false) - * @return boolean always true + * @return boolean always true */ function setCheckboxes(container_id, state) { @@ -716,7 +716,7 @@ function setCheckboxes(container_id, state) * @param string the element name * @param boolean whether to check or to uncheck options * - * @return boolean always true + * @return boolean always true */ function setSelectOptions(the_form, the_select, do_check) { @@ -1403,7 +1403,7 @@ $(function() { * @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 + * @return jQuery object jQuery Element that holds the message div * this object can be passed to PMA_ajaxRemoveMessage() * to remove the notification */ @@ -1687,7 +1687,7 @@ function PMA_createTableDialog( $div, url , target) * error: Callback function when the get request fails. TODO: Apply callback on timeouts aswell * } * - * @return object The created highcharts instance + * @return object The created highcharts instance */ function PMA_createChart(passedSettings) { @@ -1867,7 +1867,7 @@ function PMA_createProfilingChart(data, options) * * @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 + * @return string The formatted number */ function PMA_prettyProfilingNum(num, acc) { @@ -1891,7 +1891,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 - * @return string The formatted query + * @return string The formatted query */ function PMA_SQLPrettyPrint(string) { @@ -2085,7 +2085,7 @@ jQuery.fn.PMA_confirm = function(question, url, callbackFn) { * * @param string text_selector string to select the sortKey's text * - * @return jQuery Object for chaining purposes + * @return jQuery Object for chaining purposes */ jQuery.fn.PMA_sort_table = function(text_selector) { return this.each(function() { @@ -2834,7 +2834,7 @@ $(function() { * key, lock index name to 'PRIMARY' * @param string form_id Variable which parses the form name as * the input - * @return boolean false if there is no index form, true else + * @return boolean false if there is no index form, true else */ function checkIndexName(form_id) { @@ -3344,7 +3344,7 @@ $(function() { * provided, one will be created below the * navigation links at the top of the page * - * @return bool True on success, false on failure + * @return bool True on success, false on failure */ function PMA_slidingMessage(msg, $obj) { diff --git a/js/jquery/jquery-ui-1.8.16.custom.js b/js/jquery/jquery-ui-1.8.16.custom.js index 5ccc2a1589..4689c7a49a 100644 --- a/js/jquery/jquery-ui-1.8.16.custom.js +++ b/js/jquery/jquery-ui-1.8.16.custom.js @@ -8670,7 +8670,7 @@ $.extend(Datepicker.prototype, { /* Retrieve the instance data for the target control. @param target element - the target input field or division or span - @return object - the associated instance data + @return object - the associated instance data @throws error if a jQuery problem getting data */ _getInst: function(target) { try { @@ -8989,7 +8989,7 @@ $.extend(Datepicker.prototype, { /* Retrieve the size of left and top borders for an element. @param elem (jQuery object) the element of interest - @return (number[2]) the left and top borders */ + @return (number[2]) the left and top borders */ _getBorders: function(elem) { var convert = function(value) { return {thin: 1, medium: 2, thick: 3}[value] || value; @@ -9200,7 +9200,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 - @return number - the number of the week within the year that contains this date */ + @return number - the number of the week within the year that contains this date */ iso8601Week: function(date) { var checkDate = new Date(date.getTime()); // Find Thursday of this week starting on Monday @@ -9222,7 +9222,7 @@ $.extend(Datepicker.prototype, { dayNames string[7] - names of the days from Sunday (optional) monthNamesShort string[12] - abbreviated names of the months (optional) monthNames string[12] - names of the months (optional) - @return Date - the extracted date value or null if value is blank */ + @return Date - the extracted date value or null if value is blank */ parseDate: function (format, value, settings) { if (format == null || value == null) throw 'Invalid arguments'; @@ -9404,7 +9404,7 @@ $.extend(Datepicker.prototype, { dayNames string[7] - names of the days from Sunday (optional) monthNamesShort string[12] - abbreviated names of the months (optional) monthNames string[12] - names of the months (optional) - @return string - the date in the above format */ + @return string - the date in the above format */ formatDate: function (format, date, settings) { if (!date) return ''; @@ -9612,7 +9612,7 @@ $.extend(Datepicker.prototype, { > 12 when midnight changeover, but then cannot generate midnight datetime, so jump to 1AM, otherwise reset. @param date (Date) the date to check - @return (Date) the corrected date */ + @return (Date) the corrected date */ _daylightSavingAdjust: function(date) { if (!date) return null; date.setHours(date.getHours() > 12 ? date.getHours() + 2 : 0); @@ -10024,7 +10024,7 @@ function isArray(a) { /* Invoke the datepicker functionality. @param options string - a command, optionally followed by additional parameters or Object - settings for attaching new datepicker functionality - @return jQuery object */ + @return jQuery object */ $.fn.datepicker = function(options){ /* Verify an empty collection wasn't passed - Fixes #6976 */ diff --git a/js/jquery/jquery.svg.js b/js/jquery/jquery.svg.js index 640b000f07..ec9aa1684e 100644 --- a/js/jquery/jquery.svg.js +++ b/js/jquery/jquery.svg.js @@ -25,7 +25,7 @@ function SVGManager() { /* Determine whether a given ActiveX control is available. @param classId (string) the ID for the ActiveX control - @return (boolean) true if found, false if not */ + @return (boolean) true if found, false if not */ function detectActiveX(classId) { try { return !!(window.ActiveXObject && new ActiveXObject(classId)); @@ -169,7 +169,7 @@ $.extend(SVGManager.prototype, { @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 */ + @return (SVGWrapper) the corresponding SVG wrapper element, or null if not attached */ _getSVG: function(container) { container = (typeof container == 'string' ? $(container)[0] : (container.jquery ? container[0] : container)); @@ -225,7 +225,7 @@ $.extend(SVGWrapper.prototype, { }, /* Retrieve the root SVG element. - @return the top-level SVG element */ + @return the top-level SVG element */ root: function() { return this._svg; }, @@ -234,7 +234,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (SVGWrapper) this root */ configure: function(settings, clear) { if (clear) { for (var i = this._svg.attributes.length - 1; i >= 0; i--) { @@ -253,7 +253,7 @@ $.extend(SVGWrapper.prototype, { /* Locate a specific element in the SVG document. @param id (string) the element's identifier - @return (element) the element reference, or null if not found */ + @return (element) the element reference, or null if not found */ getElementById: function(id) { return this._svg.ownerDocument.getElementById(id); }, @@ -261,7 +261,7 @@ $.extend(SVGWrapper.prototype, { /* Change the attributes for a SVG node. @param element (SVG element) the node to change @param settings (object) the new settings - @return (SVGWrapper) this root */ + @return (SVGWrapper) this root */ change: function(element, settings) { if (element) { for (var name in settings) { @@ -307,7 +307,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new title node */ title: function(parent, text, settings) { var args = this._args(arguments, ['text']); var node = this._makeNode(args.parent, 'title', args.settings || {}); @@ -319,7 +319,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new description node */ describe: function(parent, text, settings) { var args = this._args(arguments, ['text']); var node = this._makeNode(args.parent, 'desc', args.settings || {}); @@ -331,7 +331,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new definitions node */ defs: function(parent, id, settings) { var args = this._args(arguments, ['id'], ['id']); return this._makeNode(args.parent, 'defs', $.extend( @@ -346,7 +346,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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']); return this._makeNode(args.parent, 'symbol', $.extend({id: args.id, @@ -363,7 +363,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new marker node */ marker: function(parent, id, refX, refY, mWidth, mHeight, orient, settings) { var args = this._args(arguments, ['id', 'refX', 'refY', 'mWidth', 'mHeight', 'orient'], ['orient']); @@ -376,7 +376,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new style node */ style: function(parent, styles, settings) { var args = this._args(arguments, ['styles']); var node = this._makeNode(args.parent, 'style', $.extend( @@ -393,7 +393,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new script node */ script: function(parent, script, type, settings) { var args = this._args(arguments, ['script', 'type'], ['type']); var node = this._makeNode(args.parent, 'script', $.extend( @@ -417,7 +417,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new gradient node */ linearGradient: function(parent, id, stops, x1, y1, x2, y2, settings) { var args = this._args(arguments, ['id', 'stops', 'x1', 'y1', 'x2', 'y2'], ['x1']); @@ -439,7 +439,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new gradient node */ radialGradient: function(parent, id, stops, cx, cy, r, fx, fy, settings) { var args = this._args(arguments, ['id', 'stops', 'cx', 'cy', 'r', 'fx', 'fy'], ['cx']); @@ -474,7 +474,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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', 'vx', 'vy', 'vwidth', 'vheight'], ['vx']); @@ -492,7 +492,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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']); return this._makeNode(args.parent, 'mask', $.extend( @@ -501,13 +501,13 @@ $.extend(SVGWrapper.prototype, { }, /* Create a new path object. - @return (SVGPath) a new path object */ + @return (SVGPath) a new path object */ createPath: function() { return new SVGPath(); }, /* Create a new text object. - @return (SVGText) a new text object */ + @return (SVGText) a new text object */ createText: function() { return new SVGText(); }, @@ -524,7 +524,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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', 'vx', 'vy', 'vwidth', 'vheight'], ['vx']); @@ -538,7 +538,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new group node */ group: function(parent, id, settings) { var args = this._args(arguments, ['id'], ['id']); return this._makeNode(args.parent, 'g', $.extend({id: args.id}, args.settings || {})); @@ -553,7 +553,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new node */ use: function(parent, x, y, width, height, ref, settings) { var args = this._args(arguments, ['x', 'y', 'width', 'height', 'ref']); if (typeof args.x == 'string') { @@ -572,7 +572,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new link node */ link: function(parent, ref, settings) { var args = this._args(arguments, ['ref']); var node = this._makeNode(args.parent, 'a', args.settings); @@ -588,7 +588,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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']); var node = this._makeNode(args.parent, 'image', $.extend( @@ -602,7 +602,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ path: function(parent, path, settings) { var args = this._args(arguments, ['path']); return this._makeNode(args.parent, 'path', $.extend( @@ -619,7 +619,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @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']); return this._makeNode(args.parent, 'rect', $.extend( @@ -633,7 +633,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ circle: function(parent, cx, cy, r, settings) { var args = this._args(arguments, ['cx', 'cy', 'r']); return this._makeNode(args.parent, 'circle', $.extend( @@ -647,7 +647,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ ellipse: function(parent, cx, cy, rx, ry, settings) { var args = this._args(arguments, ['cx', 'cy', 'rx', 'ry']); return this._makeNode(args.parent, 'ellipse', $.extend( @@ -661,7 +661,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ line: function(parent, x1, y1, x2, y2, settings) { var args = this._args(arguments, ['x1', 'y1', 'x2', 'y2']); return this._makeNode(args.parent, 'line', $.extend( @@ -672,7 +672,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ polyline: function(parent, points, settings) { var args = this._args(arguments, ['points']); return this._poly(args.parent, 'polyline', args.points, args.settings); @@ -682,7 +682,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new shape node */ polygon: function(parent, points, settings) { var args = this._args(arguments, ['points']); return this._poly(args.parent, 'polygon', args.points, args.settings); @@ -706,7 +706,7 @@ $.extend(SVGWrapper.prototype, { @param value (string) the text content or (SVGText) text with spans and references @param settings (object) additional settings for the text (optional) - @return (element) the new text node */ + @return (element) the new text node */ text: function(parent, x, y, value, settings) { var args = this._args(arguments, ['x', 'y', 'value']); if (typeof args.x == 'string' && arguments.length < 4) { @@ -726,7 +726,7 @@ $.extend(SVGWrapper.prototype, { @param value (string) the text content or (SVGText) text with spans and references @param settings (object) additional settings for the text (optional) - @return (element) the new text node */ + @return (element) the new text node */ textpath: function(parent, path, value, settings) { var args = this._args(arguments, ['path', 'value']); var node = this._text(args.parent, 'textPath', args.value, args.settings || {}); @@ -773,7 +773,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (element) the new custom node */ other: function(parent, name, settings) { var args = this._args(arguments, ['name']); return this._makeNode(args.parent, args.name, args.settings || {}); @@ -799,7 +799,7 @@ $.extend(SVGWrapper.prototype, { @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 */ + @return (SVGWrapper) this wrapper */ add: function(parent, node) { var args = this._args((arguments.length == 1 ? [null, parent] : arguments), ['node']); var svg = this; @@ -886,7 +886,7 @@ $.extend(SVGWrapper.prototype, { onLoad (function) callback after the document has loaded, 'this' is the container, receives SVG object and optional error message as a parameter - @return (SVGWrapper) this root */ + @return (SVGWrapper) this root */ load: function(url, settings) { settings = (typeof settings == 'boolean'? {addTo: settings} : (typeof settings == 'function'? {onLoad: settings} : settings || {})); @@ -977,7 +977,7 @@ $.extend(SVGWrapper.prototype, { /* Delete a specified node. @param node (element or jQuery) the drawing node to remove - @return (SVGWrapper) this root */ + @return (SVGWrapper) this root */ remove: function(node) { node = (node.jquery ? node[0] : node); node.parentNode.removeChild(node); @@ -987,7 +987,7 @@ $.extend(SVGWrapper.prototype, { /* Delete everything in the current document. @param attrsToo (boolean) true to clear any root attributes as well, false to leave them (optional) - @return (SVGWrapper) this root */ + @return (SVGWrapper) this root */ clear: function(attrsToo) { if (attrsToo) { this.configure({}, true); @@ -1000,7 +1000,7 @@ $.extend(SVGWrapper.prototype, { /* Serialise the current diagram into an SVG text document. @param node (SVG element) the starting node (optional) - @return (string) the SVG as text */ + @return (string) the SVG as text */ toSVG: function(node) { node = node || this._svg; return (typeof XMLSerializer == 'undefined' ? this._toSVG(node) : @@ -1069,7 +1069,7 @@ function SVGPath() { $.extend(SVGPath.prototype, { /* Prepare to create a new path. - @return (SVGPath) this path */ + @return (SVGPath) this path */ reset: function() { this._path = ''; return this; @@ -1081,7 +1081,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ move: function(x, y, relative) { relative = (isArray(x) ? y : relative); return this._coords((relative ? 'm' : 'M'), x, y); @@ -1093,7 +1093,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ line: function(x, y, relative) { relative = (isArray(x) ? y : relative); return this._coords((relative ? 'l' : 'L'), x, y); @@ -1104,7 +1104,7 @@ $.extend(SVGPath.prototype, { (number[]) x-coordinates to draw to @param relative (boolean) true for coordinates relative to the current point, false for coordinates being absolute - @return (SVGPath) this path */ + @return (SVGPath) this path */ horiz: function(x, relative) { this._path += (relative ? 'h' : 'H') + (isArray(x) ? x.join(' ') : x); return this; @@ -1115,7 +1115,7 @@ $.extend(SVGPath.prototype, { (number[]) y-coordinates to draw to @param relative (boolean) true for coordinates relative to the current point, false for coordinates being absolute - @return (SVGPath) this path */ + @return (SVGPath) this path */ vert: function(y, relative) { this._path += (relative ? 'v' : 'V') + (isArray(y) ? y.join(' ') : y); return this; @@ -1131,7 +1131,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ curveC: function(x1, y1, x2, y2, x, y, relative) { relative = (isArray(x1) ? y1 : relative); return this._coords((relative ? 'c' : 'C'), x1, y1, x2, y2, x, y); @@ -1146,7 +1146,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ smoothC: function(x2, y2, x, y, relative) { relative = (isArray(x2) ? y2 : relative); return this._coords((relative ? 's' : 'S'), x2, y2, x, y); @@ -1160,7 +1160,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ curveQ: function(x1, y1, x, y, relative) { relative = (isArray(x1) ? y1 : relative); return this._coords((relative ? 'q' : 'Q'), x1, y1, x, y); @@ -1173,7 +1173,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ smoothQ: function(x, y, relative) { relative = (isArray(x) ? y : relative); return this._coords((relative ? 't' : 'T'), x, y); @@ -1210,7 +1210,7 @@ $.extend(SVGPath.prototype, { @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 */ + @return (SVGPath) this path */ arc: function(rx, ry, xRotate, large, clockwise, x, y, relative) { relative = (isArray(rx) ? ry : relative); this._path += (relative ? 'a' : 'A'); @@ -1230,14 +1230,14 @@ $.extend(SVGPath.prototype, { }, /* Close the current path. - @return (SVGPath) this path */ + @return (SVGPath) this path */ close: function() { this._path += 'z'; return this; }, /* Return the string rendering of the specified path. - @return (string) stringified path */ + @return (string) stringified path */ path: function() { return this._path; } @@ -1265,7 +1265,7 @@ function SVGText() { $.extend(SVGText.prototype, { /* Prepare to create a new text object. - @return (SVGText) this text */ + @return (SVGText) this text */ reset: function() { this._parts = []; return this; @@ -1273,7 +1273,7 @@ $.extend(SVGText.prototype, { /* Add a straight string value. @param value (string) the actual text - @return (SVGText) this text object */ + @return (SVGText) this text object */ string: function(value) { this._parts[this._parts.length] = ['text', value]; return this; @@ -1282,7 +1282,7 @@ $.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 - @return (SVGText) this text object */ + @return (SVGText) this text object */ span: function(value, settings) { this._parts[this._parts.length] = ['tspan', value, settings]; return this; @@ -1291,7 +1291,7 @@ $.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 - @return (SVGText) this text object */ + @return (SVGText) this text object */ ref: function(id, settings) { this._parts[this._parts.length] = ['tref', id, settings]; return this; @@ -1301,7 +1301,7 @@ $.extend(SVGText.prototype, { @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 */ + @return (SVGText) this text object */ path: function(id, value, settings) { this._parts[this._parts.length] = ['textpath', value, $.extend({href: id}, settings || {})]; diff --git a/js/navigation.js b/js/navigation.js index 046cd2b216..9800d1d407 100644 --- a/js/navigation.js +++ b/js/navigation.js @@ -113,7 +113,7 @@ function PMA_setFrameSize() * retrieves a named value from cookie * * @param string name name of the value to retrieve - * @return string value value for the given name from cookie + * @return string value value for the given name from cookie */ function PMA_getCookie(name) { diff --git a/js/server_privileges.js b/js/server_privileges.js index 01a844f9b2..050ec45d79 100644 --- a/js/server_privileges.js +++ b/js/server_privileges.js @@ -15,7 +15,7 @@ * @see PMA_messages['strPasswordEmpty'] * @see PMA_messages['strPasswordNotSame'] * @param object the form - * @return boolean whether the field value is valid or not + * @return boolean whether the field value is valid or not */ function checkPassword(the_form) { @@ -54,7 +54,7 @@ function checkPassword(the_form) /** * Validates the "add a user" form * - * @return boolean whether the form is validated or not + * @return boolean whether the form is validated or not */ function checkAddUser(the_form) { diff --git a/js/server_synchronize.js b/js/server_synchronize.js index 4dcaa93d1b..e61e02281e 100644 --- a/js/server_synchronize.js +++ b/js/server_synchronize.js @@ -250,7 +250,7 @@ function ApplySelectedChanges(token) * Validates a partial form (source part or target part) * * @param which 'src' or 'trg' - * @return boolean whether the partial form is valid + * @return boolean whether the partial form is valid * */ function validateSourceOrTarget(which) @@ -277,7 +277,7 @@ function validateSourceOrTarget(which) * is left empty other than the port field, unless * we are dealing with the "current connection" choice * -* @return boolean whether the form is valid +* @return boolean whether the form is valid */ function validateConnectionParams() { diff --git a/js/tbl_change.js b/js/tbl_change.js index 2473ef8e6d..05132d3664 100644 --- a/js/tbl_change.js +++ b/js/tbl_change.js @@ -16,7 +16,7 @@ * @param md5Field string the md5 hashed field name * @param multi_edit string the multi_edit row sequence number * - * @return boolean always true + * @return boolean always true */ function nullify(theType, urlField, md5Field, multi_edit) { diff --git a/libraries/Config.class.php b/libraries/Config.class.php index 18afa03982..6b043ddc22 100644 --- a/libraries/Config.class.php +++ b/libraries/Config.class.php @@ -540,7 +540,7 @@ class PMA_Config /** * loads default values from default source * - * @return boolean success + * @return boolean success */ function loadDefaults() { @@ -892,7 +892,7 @@ class PMA_Config /** * check config source * - * @return boolean whether source is valid or not + * @return boolean whether source is valid or not */ function checkConfigSource() { @@ -991,7 +991,7 @@ class PMA_Config /** * returns source for current config * - * @return string config source + * @return string config source */ function getSource() { diff --git a/libraries/Error.class.php b/libraries/Error.class.php index fc7e4590f5..f78c3ee101 100644 --- a/libraries/Error.class.php +++ b/libraries/Error.class.php @@ -178,7 +178,7 @@ class PMA_Error extends PMA_Message /** * returns PMA_Error::$_backtrace * - * @return array PMA_Error::$_backtrace + * @return array PMA_Error::$_backtrace */ public function getBacktrace() { @@ -188,7 +188,7 @@ class PMA_Error extends PMA_Message /** * returns PMA_Error::$_file * - * @return string PMA_Error::$_file + * @return string PMA_Error::$_file */ public function getFile() { @@ -198,7 +198,7 @@ class PMA_Error extends PMA_Message /** * returns PMA_Error::$_line * - * @return integer PMA_Error::$_line + * @return integer PMA_Error::$_line */ public function getLine() { @@ -208,7 +208,7 @@ class PMA_Error extends PMA_Message /** * returns type of error * - * @return string type of error + * @return string type of error */ public function getType() { @@ -218,7 +218,7 @@ class PMA_Error extends PMA_Message /** * returns level of error * - * @return string level of error + * @return string level of error */ public function getLevel() { @@ -228,7 +228,7 @@ class PMA_Error extends PMA_Message /** * returns title prepared for HTML Title-Tag * - * @return string HTML escaped and truncated title + * @return string HTML escaped and truncated title */ public function getHtmlTitle() { @@ -329,7 +329,7 @@ class PMA_Error extends PMA_Message /** * whether this error is a user error * - * @return boolean + * @return boolean */ public function isUserError() { @@ -344,7 +344,7 @@ class PMA_Error extends PMA_Message * * @param string $dest path to be shorten * - * @return string shortened path + * @return string shortened path * @static */ static function relPath($dest) diff --git a/libraries/Error_Handler.class.php b/libraries/Error_Handler.class.php index 507f8d725d..3dde178a8d 100644 --- a/libraries/Error_Handler.class.php +++ b/libraries/Error_Handler.class.php @@ -296,7 +296,7 @@ class PMA_Error_Handler /** * return count of errors * - * @return integer number of errors occoured + * @return integer number of errors occoured */ public function countErrors() { @@ -306,7 +306,7 @@ class PMA_Error_Handler /** * return count of user errors * - * @return integer number of user errors occoured + * @return integer number of user errors occoured */ public function countUserErrors() { @@ -325,7 +325,7 @@ class PMA_Error_Handler /** * whether use errors occured or not * - * @return boolean + * @return boolean */ public function hasUserErrors() { @@ -335,7 +335,7 @@ class PMA_Error_Handler /** * whether errors occured or not * - * @return boolean + * @return boolean */ public function hasErrors() { diff --git a/libraries/File.class.php b/libraries/File.class.php index 1623dcb36d..515b93eec5 100644 --- a/libraries/File.class.php +++ b/libraries/File.class.php @@ -101,7 +101,7 @@ class PMA_File * deletes file if it is temporary, usally from a moved upload file * * @access public - * @return boolean success + * @return boolean success */ function cleanUp() { @@ -116,7 +116,7 @@ class PMA_File * deletes the file * * @access public - * @return boolean success + * @return boolean success */ function delete() { @@ -129,7 +129,7 @@ class PMA_File * * @param boolean $is_temp sets the temp flag * - * @return boolean PMA_File::$_is_temp + * @return boolean PMA_File::$_is_temp * @access public */ function isTemp($is_temp = null) @@ -156,7 +156,7 @@ class PMA_File /** * - * @return string binary file content + * @return string binary file content * * @access public */ @@ -204,7 +204,7 @@ class PMA_File * accessor * * @access public - * @return string PMA_File::$_name + * @return string PMA_File::$_name */ function getName() { @@ -215,7 +215,7 @@ class PMA_File * * @param string $name name of file uploaded * - * @return boolean success + * @return boolean success * @access public */ function setUploadedFile($name) @@ -235,7 +235,7 @@ class PMA_File * @param string $key the md5 hash of the column name * @param string $rownumber * - * @return boolean success + * @return boolean success * @access public */ function setUploadedFromTblChangeRequest($key, $rownumber) @@ -303,7 +303,7 @@ class PMA_File * @param string $rownumber * @param string $key * - * @return array + * @return array * @access public * @static */ @@ -326,7 +326,7 @@ class PMA_File * @param string $key the md5 hash of the column name * @param string $rownumber * - * @return boolean success + * @return boolean success * @access public */ function setSelectedFromTblChangeRequest($key, $rownumber = null) @@ -343,7 +343,7 @@ class PMA_File /** * @access public - * @return string error message + * @return string error message */ function getError() { @@ -352,7 +352,7 @@ class PMA_File /** * @access public - * @return boolean whether an error occured or not + * @return boolean whether an error occured or not */ function isError() { @@ -366,7 +366,7 @@ class PMA_File * @param string $key the md5 hash of the column name * @param string $rownumber * - * @return boolean success + * @return boolean success * @access public */ function checkTblChangeForm($key, $rownumber) @@ -389,7 +389,7 @@ class PMA_File * * @param string $name * - * @return boolean success + * @return boolean success * @access public */ function setLocalSelectedFile($name) @@ -410,7 +410,7 @@ class PMA_File /** * @access public - * @return boolean whether the file is readable or not + * @return boolean whether the file is readable or not */ function isReadable() { @@ -429,7 +429,7 @@ class PMA_File * * @todo move check of $cfg['TempDir'] into PMA_Config? * @access public - * @return boolean whether uploaded fiel is fine or not + * @return boolean whether uploaded fiel is fine or not */ function checkUploadedFile() { @@ -472,7 +472,7 @@ class PMA_File * @todo move file read part into readChunk() or getChunk() * @todo add support for compression plugins * @access protected - * @return string MIME type of compression, none for none + * @return string MIME type of compression, none for none */ function _detectCompression() { @@ -604,7 +604,7 @@ class PMA_File } /** - * @return string MIME type of compression, none for none + * @return string MIME type of compression, none for none * @access public */ function getCompression() @@ -621,7 +621,7 @@ class PMA_File * * @param integer $length numbers of chars/bytes to skip * - * @return boolean + * @return boolean * @todo this function is unused */ function advanceFilePointer($length) diff --git a/libraries/Index.class.php b/libraries/Index.class.php index 32f9580353..b73892c8e3 100644 --- a/libraries/Index.class.php +++ b/libraries/Index.class.php @@ -117,7 +117,7 @@ class PMA_Index * @param string $table table * @param string $schema schema * - * @return array array of indexes + * @return array array of indexes */ static public function getFromTable($table, $schema) { @@ -136,7 +136,7 @@ class PMA_Index * @param string $table table * @param string $schema schema * - * @return mixed primary index or false if no one exists + * @return mixed primary index or false if no one exists */ static public function getPrimary($table, $schema) { @@ -155,7 +155,7 @@ class PMA_Index * @param string $table table * @param string $schema schema * - * @return boolean whether loading was successful + * @return boolean whether loading was successful */ static protected function _loadIndexes($table, $schema) { @@ -226,7 +226,7 @@ class PMA_Index * * @param string $column the column * - * @return boolean true if $column indexed in this index + * @return boolean true if $column indexed in this index */ public function hasColumn($column) { @@ -314,7 +314,7 @@ class PMA_Index /** * Return a list of all index choices * - * @return array index choices + * @return array index choices */ static public function getIndexChoices() { @@ -417,7 +417,7 @@ class PMA_Index * @param string $schema The schema name * @param boolean $print_mode Whether the output is for the print mode * - * @return array Index collection array + * @return array Index collection array * * @access public */ @@ -569,7 +569,7 @@ class PMA_Index * @param string $table table name * @param string $schema schema name * - * @return string Output HTML + * @return string Output HTML * @access public */ static public function findDuplicates($table, $schema) diff --git a/libraries/List.class.php b/libraries/List.class.php index dff7ee0750..817b507975 100644 --- a/libraries/List.class.php +++ b/libraries/List.class.php @@ -30,7 +30,7 @@ abstract class PMA_List extends ArrayObject /** * returns item only if there is only one in the list * - * @return single item + * @return single item */ public function getSingleItem() { @@ -44,7 +44,7 @@ abstract class PMA_List extends ArrayObject /** * defines what is an empty item (0, '', false or null) * - * @return mixed an empty item + * @return mixed an empty item */ public function getEmpty() { @@ -55,7 +55,7 @@ abstract class PMA_List extends ArrayObject * checks if the given db names exists in the current list, if there is * missing at least one item it returns false otherwise true * - * @return boolean true if all items exists, otheriwse false + * @return boolean true if all items exists, otheriwse false */ public function exists() { @@ -76,7 +76,7 @@ abstract class PMA_List extends ArrayObject * selecting current db * @param boolean $include_information_schema whether include information schema * - * @return string HTML option tags + * @return string HTML option tags */ public function getHtmlOptions($selected = '', $include_information_schema = true) { @@ -104,7 +104,7 @@ abstract class PMA_List extends ArrayObject /** * returns default item * - * @return string default item + * @return string default item */ public function getDefault() { diff --git a/libraries/List_Database.class.php b/libraries/List_Database.class.php index 77ab42d225..b1d17ff2a4 100644 --- a/libraries/List_Database.class.php +++ b/libraries/List_Database.class.php @@ -162,7 +162,7 @@ require_once './libraries/List.class.php'; /** * checks the only_db configuration * - * @return boolean false if there is no only_db, otherwise true + * @return boolean false if there is no only_db, otherwise true */ protected function _checkOnlyDatabase() { @@ -214,7 +214,7 @@ require_once './libraries/List.class.php'; /** * returns default item * - * @return string default item + * @return string default item */ public function getDefault() { @@ -231,7 +231,7 @@ require_once './libraries/List.class.php'; * @param integer $offset * @param integer $count * - * @return array db list + * @return array db list */ public function getGroupedDetails($offset, $count) { @@ -310,7 +310,7 @@ require_once './libraries/List.class.php'; * @param integer $offset * @param integer $count * - * @return array some items + * @return array some items */ public function getLimitedItems($offset, $count) { @@ -320,7 +320,7 @@ require_once './libraries/List.class.php'; /** * returns html code for list with dbs * - * @return string html code list + * @return string html code list */ public function getHtmlListGrouped($selected = '', $offset, $count) { @@ -376,7 +376,7 @@ require_once './libraries/List.class.php'; * as mostly names will be in english, we set the whole selectbox to LTR * and EN * - * @return string html code select + * @return string html code select */ public function getHtmlSelectGrouped($selected = '', $offset, $count) { diff --git a/libraries/Message.class.php b/libraries/Message.class.php index 884bf564a5..a79b794b57 100644 --- a/libraries/Message.class.php +++ b/libraries/Message.class.php @@ -168,7 +168,7 @@ class PMA_Message * @param string $string a localized string * e.g. __('Your SQL query has been executed successfully') * - * @return PMA_Message + * @return PMA_Message * @static */ static public function success($string = '') @@ -187,7 +187,7 @@ class PMA_Message * * @param string $string a localized string e.g. __('Error') * - * @return PMA_Message + * @return PMA_Message * @static */ static public function error($string = '') @@ -208,7 +208,7 @@ class PMA_Message * e.g. __('The additional features for working with linked * tables have been deactivated. To find out why click %shere%s.') * - * @return PMA_Message + * @return PMA_Message * @static */ static public function notice($string) @@ -224,7 +224,7 @@ class PMA_Message * @param string $message * @param integer $type * - * @return PMA_Message + * @return PMA_Message * @static */ static public function raw($message, $type = PMA_Message::NOTICE) @@ -241,7 +241,7 @@ class PMA_Message * * @param integer $rows Number of rows * - * @return PMA_Message + * @return PMA_Message * @static */ static public function affected_rows($rows) @@ -258,7 +258,7 @@ class PMA_Message * * @param integer $rows Number of rows * - * @return PMA_Message + * @return PMA_Message * @static */ static public function deleted_rows($rows) @@ -275,7 +275,7 @@ class PMA_Message * * @param integer $rows Number of rows * - * @return PMA_Message + * @return PMA_Message * @static */ static public function inserted_rows($rows) @@ -292,7 +292,7 @@ class PMA_Message * * @param string $message * - * @return PMA_Message + * @return PMA_Message * @static */ static public function rawError($message) @@ -307,7 +307,7 @@ class PMA_Message * * @param string $message * - * @return PMA_Message + * @return PMA_Message * @static */ static public function rawNotice($message) @@ -322,7 +322,7 @@ class PMA_Message * * @param string $message * - * @return PMA_Message + * @return PMA_Message * @static */ static public function rawSuccess($message) @@ -336,7 +336,7 @@ class PMA_Message * * @param boolean $set * - * @return boolean whether this is a success message or not + * @return boolean whether this is a success message or not */ public function isSuccess($set = false) { @@ -353,7 +353,7 @@ class PMA_Message * * @param boolean $set * - * @return boolean whether this is a notice message or not + * @return boolean whether this is a notice message or not */ public function isNotice($set = false) { @@ -370,7 +370,7 @@ class PMA_Message * * @param boolean $set * - * @return boolean whether this is an error message or not + * @return boolean whether this is an error message or not */ public function isError($set = false) { @@ -539,7 +539,7 @@ class PMA_Message * * @param mixed $message the message(s) * - * @return mixed the sanitized message(s) + * @return mixed the sanitized message(s) * @access public * @static */ @@ -562,7 +562,7 @@ class PMA_Message * * @param string $message the message * - * @return string the decoded message + * @return string the decoded message * @access public * @static */ @@ -574,7 +574,7 @@ class PMA_Message /** * wrapper for sprintf() * - * @return string formatted + * @return string formatted */ static public function format() { @@ -590,7 +590,7 @@ class PMA_Message /** * returns unique PMA_Message::$_hash, if not exists it will be created * - * @return string PMA_Message::$_hash + * @return string PMA_Message::$_hash */ public function getHash() { @@ -608,7 +608,7 @@ class PMA_Message /** * returns compiled message * - * @return string complete message + * @return string complete message */ public function getMessage() { @@ -641,7 +641,7 @@ class PMA_Message /** * returns PMA_Message::$_string * - * @return string PMA_Message::$_string + * @return string PMA_Message::$_string */ public function getString() { @@ -651,7 +651,7 @@ class PMA_Message /** * returns PMA_Message::$_number * - * @return integer PMA_Message::$_number + * @return integer PMA_Message::$_number */ public function getNumber() { @@ -661,7 +661,7 @@ class PMA_Message /** * returns level of message * - * @return string level of message + * @return string level of message */ public function getLevel() { @@ -694,7 +694,7 @@ class PMA_Message * * @param boolean $is_displayed * - * @return boolean PMA_Message::$_is_displayed + * @return boolean PMA_Message::$_is_displayed */ public function isDisplayed($is_displayed = false) { diff --git a/libraries/Partition.class.php b/libraries/Partition.class.php index 43609e3c1c..63585371ab 100644 --- a/libraries/Partition.class.php +++ b/libraries/Partition.class.php @@ -19,7 +19,7 @@ class PMA_Partition * returns array of partition names for a specific db/table * * @access public - * @return array of partition names + * @return array of partition names */ static public function getPartitionNames($db, $table) { @@ -37,7 +37,7 @@ class PMA_Partition * @staticvar boolean $have_partitioning * @staticvar boolean $already_checked * @access public - * @return boolean + * @return boolean */ static public function havePartitioning() { diff --git a/libraries/StorageEngine.class.php b/libraries/StorageEngine.class.php index d99fe3b3f8..fbd8b10f65 100644 --- a/libraries/StorageEngine.class.php +++ b/libraries/StorageEngine.class.php @@ -54,7 +54,7 @@ class PMA_StorageEngine * @static * @staticvar array $storage_engines storage engines * @access public - * @return array of storage engines + * @return array of storage engines */ static public function getStorageEngines() { @@ -91,7 +91,7 @@ class PMA_StorageEngine * @param boolean $offerUnavailableEngines Should unavailable storage engines be offered? * * @static - * @return string html selectbox + * @return string html selectbox */ static public function getHtmlSelect($name = 'engine', $id = null, $selected = null, $offerUnavailableEngines = false) @@ -131,7 +131,7 @@ class PMA_StorageEngine * * @param string $engine The engine ID * - * @return object The engine plugin + * @return object The engine plugin */ static public function getEngine($engine) { @@ -154,7 +154,7 @@ class PMA_StorageEngine * @param string $engine name of engine * * @static - * @return boolean whether $engine is valid or not + * @return boolean whether $engine is valid or not */ static public function isValid($engine) { @@ -230,7 +230,7 @@ class PMA_StorageEngine /** * returns array with detailed info about engine specific server variables * - * @return array with detailed info about specific engine server variables + * @return array with detailed info about specific engine server variables */ function getVariablesStatus() { @@ -332,7 +332,7 @@ class PMA_StorageEngine /** * public String getSupportInformationMessage() * - * @return string The localized message. + * @return string The localized message. */ function getSupportInformationMessage() { @@ -361,7 +361,7 @@ class PMA_StorageEngine * for a particular engine. * * @abstract - * @return Array The list of variables. + * @return Array The list of variables. */ function getVariables() { @@ -372,7 +372,7 @@ class PMA_StorageEngine * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { @@ -383,7 +383,7 @@ class PMA_StorageEngine * public string getVariablesLikePattern() * * @abstract - * @return string SQL query LIKE pattern + * @return string SQL query LIKE pattern */ function getVariablesLikePattern() { @@ -396,7 +396,7 @@ class PMA_StorageEngine * Returns a list of available information pages with labels * * @abstract - * @return array The list + * @return array The list */ function getInfoPages() { @@ -411,7 +411,7 @@ class PMA_StorageEngine * @param string $id The page ID * * @abstract - * @return string The page + * @return string The page * boolean or false on error. */ function getPage($id) diff --git a/libraries/Table.class.php b/libraries/Table.class.php index 27b67268a0..41f9c4dedb 100644 --- a/libraries/Table.class.php +++ b/libraries/Table.class.php @@ -79,7 +79,7 @@ class PMA_Table * returns table name * * @see PMA_Table::getName() - * @return string table name + * @return string table name */ function __toString() { @@ -123,7 +123,7 @@ class PMA_Table * * @param boolean $backquoted whether to quote name with backticks `` * - * @return string table name + * @return string table name */ function getName($backquoted = false) { @@ -150,7 +150,7 @@ class PMA_Table * * @param boolean $backquoted whether to quote name with backticks `` * - * @return string database name for this table + * @return string database name for this table */ function getDbName($backquoted = false) { @@ -223,7 +223,7 @@ class PMA_Table * * @param string $param name for value to return * - * @return mixed value for $param + * @return mixed value for $param */ function get($param) { @@ -286,7 +286,7 @@ class PMA_Table * @param string $db the database name * @param string $table the table name * - * @return boolean true if it is a merge table + * @return boolean true if it is a merge table */ static public function isMerge($db = null, $table = null) { @@ -378,7 +378,7 @@ class PMA_Table * @todo on the interface, some js to clear the default value when the * default current_timestamp is checked * - * @return string field specification + * @return string field specification */ static function generateFieldSpec($name, $type, $length = '', $attribute = '', $collation = '', $null = false, $default_type = 'USER_DEFINED', @@ -603,7 +603,7 @@ class PMA_Table * * @see PMA_Table::generateFieldSpec() * - * @return string field specification + * @return string field specification */ static public function generateAlter($oldcol, $newcol, $type, $length, $attribute, $collation, $null, $default_type, $default_value, @@ -1126,7 +1126,7 @@ class PMA_Table * @todo add check for valid chars in filename on current system/os * @see http://dev.mysql.com/doc/refman/5.0/en/legal-names.html * - * @return boolean whether the string is valid or not + * @return boolean whether the string is valid or not */ function isValidName($table_name) { diff --git a/libraries/Theme.class.php b/libraries/Theme.class.php index e855f801e4..15fedeb580 100644 --- a/libraries/Theme.class.php +++ b/libraries/Theme.class.php @@ -73,7 +73,7 @@ class PMA_Theme /** * @access public - * @return boolean whether loading them info was successful or not + * @return boolean whether loading them info was successful or not */ function loadInfo() { @@ -112,7 +112,7 @@ class PMA_Theme * @static * @access public * @param string $folder path to theme - * @return object PMA_Theme + * @return object PMA_Theme */ static public function load($folder) { @@ -156,7 +156,7 @@ class PMA_Theme * returns path to theme * * @access public - * @return string $path path to theme + * @return string $path path to theme */ function getPath() { @@ -167,7 +167,7 @@ class PMA_Theme * returns layout file * * @access public - * @return string layout file + * @return string layout file */ function getLayoutFile() { @@ -200,7 +200,7 @@ class PMA_Theme * returns version * * @access public - * @return string version + * @return string version */ function getVersion() { @@ -213,7 +213,7 @@ class PMA_Theme * * @access public * @param string $version version to compare to - * @return boolean + * @return boolean */ function checkVersion($version) { @@ -235,7 +235,7 @@ class PMA_Theme * returns name * * @access public - * @return string name + * @return string name */ function getName() { @@ -257,7 +257,7 @@ class PMA_Theme * returns id * * @access public - * @return string id + * @return string id */ function getId() { @@ -275,7 +275,7 @@ class PMA_Theme /** * @access public - * @return string image path for this theme + * @return string image path for this theme */ function getImgPath() { diff --git a/libraries/Theme_Manager.class.php b/libraries/Theme_Manager.class.php index 638512f631..fe3add14f2 100644 --- a/libraries/Theme_Manager.class.php +++ b/libraries/Theme_Manager.class.php @@ -59,7 +59,7 @@ class PMA_Theme_Manager * sets path to folder containing the themes * * @param string $path path to themes folder - * @return boolean success + * @return boolean success */ function setThemesPath($path) { @@ -73,7 +73,7 @@ class PMA_Theme_Manager /** * @public - * @return string + * @return string */ function getThemesPath() { @@ -171,7 +171,7 @@ class PMA_Theme_Manager } /** - * @return string cookie name + * @return string cookie name */ function getThemeCookieName() { @@ -185,7 +185,7 @@ class PMA_Theme_Manager /** * returns name of theme stored in the cookie - * @return string theme name from cookie + * @return string theme name from cookie */ function getThemeCookie() { @@ -217,7 +217,7 @@ class PMA_Theme_Manager /** * @private * @param string $folder - * @return boolean + * @return boolean */ private function _checkThemeFolder($folder) { diff --git a/libraries/auth/config.auth.lib.php b/libraries/auth/config.auth.lib.php index 25896f8b3f..27524202f6 100644 --- a/libraries/auth/config.auth.lib.php +++ b/libraries/auth/config.auth.lib.php @@ -11,7 +11,7 @@ /** * Displays authentication form * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -24,7 +24,7 @@ function PMA_auth() /** * Gets advanced authentication settings * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -37,7 +37,7 @@ function PMA_auth_check() /** * Set the user and password after last checkings if required * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -61,7 +61,7 @@ function PMA_auth_set_user() * @global boolean tell the "PMA_mysqlDie()" function headers have been * sent * - * @return boolean always true (no return indeed) + * @return boolean always true (no return indeed) * * @access public */ diff --git a/libraries/auth/cookie.auth.lib.php b/libraries/auth/cookie.auth.lib.php index 1e90e8c971..09aa53ab0c 100644 --- a/libraries/auth/cookie.auth.lib.php +++ b/libraries/auth/cookie.auth.lib.php @@ -53,7 +53,7 @@ if (function_exists('mcrypt_encrypt')) { * @param string original data * @param string the secret * - * @return string the encrypted result + * @return string the encrypted result * * @access public * @@ -70,7 +70,7 @@ if (function_exists('mcrypt_encrypt')) { * @param string encrypted data * @param string the secret * - * @return string original data + * @return string original data * * @access public * @@ -337,7 +337,7 @@ if (top != self || document.body.className != 'loginform') { * arbitrary server, or? so we should also check if this is filled and * not only if allowed * - * @return boolean whether we get authentication settings or not + * @return boolean whether we get authentication settings or not * * @access public */ @@ -463,7 +463,7 @@ function PMA_auth_check() /** * Set the user and password after last checkings if required * - * @return boolean always true + * @return boolean always true * * @access public */ diff --git a/libraries/auth/http.auth.lib.php b/libraries/auth/http.auth.lib.php index 7827a94d9d..ae275cdd49 100644 --- a/libraries/auth/http.auth.lib.php +++ b/libraries/auth/http.auth.lib.php @@ -16,7 +16,7 @@ * @global string the default font size to use in case of failure * @global string the big font size to use in case of failure * - * @return boolean always true (no return indeed) + * @return boolean always true (no return indeed) * * @access public */ @@ -96,7 +96,7 @@ function PMA_auth() * @global string the password for the WebSite Professional server * @global string the username of the user who logs out * - * @return boolean whether we get authentication settings or not + * @return boolean whether we get authentication settings or not * * @access public */ @@ -183,7 +183,7 @@ function PMA_auth_check() * @global string the current username * @global string the current password * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -222,7 +222,7 @@ function PMA_auth_set_user() /** * User is not allowed to login to MySQL -> authentication failed * - * @return boolean always true (no return indeed) + * @return boolean always true (no return indeed) * * @access public */ diff --git a/libraries/auth/signon.auth.lib.php b/libraries/auth/signon.auth.lib.php index 32f0415ffb..abad41e5fe 100644 --- a/libraries/auth/signon.auth.lib.php +++ b/libraries/auth/signon.auth.lib.php @@ -15,7 +15,7 @@ * @global string the default font size to use in case of failure * @global string the big font size to use in case of failure * - * @return boolean always true (no return indeed) + * @return boolean always true (no return indeed) * * @access public */ @@ -49,7 +49,7 @@ function PMA_auth() * @global string the password for the WebSite Professional server * @global string the username of the user who logs out * - * @return boolean whether we get authentication settings or not + * @return boolean whether we get authentication settings or not * * @access public */ @@ -191,7 +191,7 @@ function PMA_auth_check() * @global string the current username * @global string the current password * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -210,7 +210,7 @@ function PMA_auth_set_user() /** * User is not allowed to login to MySQL -> authentication failed * - * @return boolean always true (no return indeed) + * @return boolean always true (no return indeed) * * @access public */ diff --git a/libraries/auth/swekey/swekey.php b/libraries/auth/swekey/swekey.php index b9c1fe29c0..02f14500a3 100644 --- a/libraries/auth/swekey/swekey.php +++ b/libraries/auth/swekey/swekey.php @@ -156,7 +156,7 @@ function Swekey_EnableTokenCache($enable) /** * Return the last error. * - * @return The Last Error + * @return The Last Error * @access public */ function Swekey_GetLastError() @@ -168,7 +168,7 @@ function Swekey_GetLastError() /** * Return the last result. * - * @return The Last Error + * @return The Last Error * @access public */ function Swekey_GetLastResult() @@ -183,7 +183,7 @@ function Swekey_GetLastResult() * * @param url The url to get * @param response_code The response code - * @return The body of the response or "" in case of error + * @return The body of the response or "" in case of error * @access private */ function Swekey_HttpGet($url, &$response_code) @@ -422,7 +422,7 @@ function Swekey_GetFastRndToken() * @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 + * @return true or false * @access public */ function Swekey_CheckOtp($id, $rt, $otp) @@ -458,7 +458,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 - * @return The text corresponding to the status + * @return The text corresponding to the status * @access public */ function Swekey_GetStatusStr($status) @@ -496,7 +496,7 @@ function Swekey_GetStatusStr($status) * 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 - * @return The status of the swekey + * @return The status of the swekey * @access public */ function Swekey_GetStatus($id) diff --git a/libraries/blowfish.php b/libraries/blowfish.php index 63809e77cc..82c67331eb 100644 --- a/libraries/blowfish.php +++ b/libraries/blowfish.php @@ -488,7 +488,7 @@ class Horde_Cipher_blowfish * @param string $data original data * @param string $secret the secret * - * @return string the encrypted result + * @return string the encrypted result * * @access public * @@ -516,7 +516,7 @@ function PMA_blowfish_encrypt($data, $secret) * @param string $encdata encrypted data * @param string $secret the secret * - * @return string original data + * @return string original data * * @access public * diff --git a/libraries/bookmark.lib.php b/libraries/bookmark.lib.php index 2642d46c9f..bc92a13251 100644 --- a/libraries/bookmark.lib.php +++ b/libraries/bookmark.lib.php @@ -12,7 +12,7 @@ if (! defined('PHPMYADMIN')) { /** * Defines the bookmark parameters for the current user * - * @return array the bookmark parameters for the current user + * @return array the bookmark parameters for the current user * @access public */ function PMA_Bookmark_getParams() @@ -93,7 +93,7 @@ function PMA_Bookmark_getList($db) * @param boolean $action_bookmark_all true: get all bookmarks regardless of the owning user * @param boolean $exact_user_match whether to ignore bookmarks with no user * - * @return string the sql query + * @return string the sql query * * @access public * @@ -133,7 +133,7 @@ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = fal * $fields['query'] is urlencoded * @param boolean $all_users whether to make the bookmark available for all users * - * @return boolean whether the INSERT succeeds or not + * @return boolean whether the INSERT succeeds or not * * @access public * diff --git a/libraries/charset_conversion.lib.php b/libraries/charset_conversion.lib.php index 271b4b1a82..78637a08c7 100644 --- a/libraries/charset_conversion.lib.php +++ b/libraries/charset_conversion.lib.php @@ -62,7 +62,7 @@ if ($PMA_recoding_engine == PMA_CHARSET_ICONV_AIX) { * @param string $dest_charset target charset * @param string $what what to convert * - * @return string converted text + * @return string converted text * * @access public * diff --git a/libraries/common.lib.php b/libraries/common.lib.php index 68dcb589e4..2619b00dc1 100644 --- a/libraries/common.lib.php +++ b/libraries/common.lib.php @@ -222,7 +222,7 @@ function PMA_generateHiddenMaxFileSize($max_size) * @param bool $php_code whether this function is used as part of the * "Create PHP code" dialog * - * @return string the slashed string + * @return string the slashed string * * @access public */ @@ -273,7 +273,7 @@ function PMA_escape_mysql_wildcards($name) * * @param string $name the string to escape * - * @return string the escaped string + * @return string the escaped string * * @access public */ @@ -418,7 +418,7 @@ function PMA_showDocLink($link, $target = 'documentation') * @param string $anchor anchor to page part * @param bool $just_open whether only the opening <a> tag should be returned * - * @return string the html link + * @return string the html link * * @access public */ @@ -506,7 +506,7 @@ function PMA_showMySQLDocu($chapter, $link, $big_icon = false, $anchor = '', $ju * * @param string $anchor anchor in documentation * - * @return string the html link + * @return string the html link * * @access public */ @@ -538,7 +538,7 @@ function PMA_showPHPDocu($target) * @param bool $bbcode * @param string $type message types * - * @return string html code for a footnote marker + * @return string html code for a footnote marker * * @access public */ @@ -739,7 +739,7 @@ function PMA_mysqlDie( * @param integer $limit_offset list offset * @param int|bool $limit_count max tables to return * - * @return array (recursive) grouped table list + * @return array (recursive) grouped table list */ function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = false) { @@ -866,7 +866,7 @@ function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = * @param boolean $do_it a flag to bypass this function (used by dump * functions) * - * @return mixed the "backquoted" database, table or field name + * @return mixed the "backquoted" database, table or field name * * @access public */ @@ -909,7 +909,7 @@ function PMA_backquote($a_name, $do_it = true) * @param mixed $a_name the "backquoted" database, table or field name * or array of it * - * @return mixed the "backquoted" database, table or field name + * @return mixed the "backquoted" database, table or field name * * @access public */ @@ -935,7 +935,7 @@ function PMA_removeBackquote($a_name) /** * Defines the <CR><LF> value depending on the user OS. * - * @return string the <CR><LF> value to use + * @return string the <CR><LF> value to use * * @access public */ @@ -1002,7 +1002,7 @@ if (typeof(window.parent) != 'undefined' * @param string $type the type (level) of the message * @param boolean $is_view is this a message after a VIEW operation? * - * @return string + * @return string * * @access public */ @@ -1378,7 +1378,7 @@ function PMA_showMessage($message, $sql_query = null, $type = 'notice', $is_view * * @access public * - * @return boolean whether profiling is supported + * @return boolean whether profiling is supported */ function PMA_profilingSupported() { @@ -1425,7 +1425,7 @@ function PMA_profilingCheckbox($sql_query) * @param int $limes the sensitiveness * @param int $comma the number of decimals to retain * - * @return array the formatted value and its unit + * @return array the formatted value and its unit * * @access public */ @@ -1521,7 +1521,7 @@ function PMA_localizeNumber($value) * @param boolean $noTrailingZero removes trailing zeros right of the comma * (default: true) * - * @return string the formatted value and its unit + * @return string the formatted value and its unit * * @access public */ @@ -1619,7 +1619,7 @@ function PMA_formatNumber( * * @param string $formatted_size the size expression (for example 8MB) * - * @return integer The numerical part of the expression (for example 8) + * @return integer The numerical part of the expression (for example 8) */ function PMA_extractValueFromFormattedSize($formatted_size) { @@ -1641,7 +1641,7 @@ function PMA_extractValueFromFormattedSize($formatted_size) * @param string $timestamp the current timestamp * @param string $format format * - * @return string the formatted date + * @return string the formatted date * * @access public */ @@ -1720,7 +1720,7 @@ function PMA_localisedDate($timestamp = -1, $format = '') * @param array $url_params * @param string $base_dir * - * @return string html code for one tab, a link if valid otherwise a span + * @return string html code for one tab, a link if valid otherwise a span * * @access public */ @@ -1825,7 +1825,7 @@ function PMA_generate_html_tab($tab, $url_params = array(), $base_dir = '') * @param string $base_dir * @param string $menu_id * - * @return string html-code for tab-navigation + * @return string html-code for tab-navigation */ function PMA_generate_html_tabs($tabs, $url_params, $base_dir = '', $menu_id = 'topmenu') { @@ -2041,7 +2041,7 @@ function PMA_timespanFormat($seconds) * @access public * @todo add a multibyte safe function PMA_STR_split() * - * @return string The flipped string + * @return string The flipped string */ function PMA_flipstring($string, $Separator = "<br />\n") { @@ -2135,7 +2135,7 @@ function PMA_checkParameters($params, $request = true) * * @access public * - * @return array the calculated condition and whether condition is unique + * @return array the calculated condition and whether condition is unique */ function PMA_getUniqueCondition($handle, $fields_cnt, $fields_meta, $row, $force_unique = false) { @@ -2556,7 +2556,7 @@ function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_cou * * @param string $dir with wildcard for user * - * @return string per user directory + * @return string per user directory */ function PMA_userDir($dir) { @@ -2573,7 +2573,7 @@ function PMA_userDir($dir) * * @param string $database database * - * @return string html link to default db page + * @return string html link to default db page */ function PMA_getDbLink($database = null) { @@ -2742,7 +2742,7 @@ function PMA_generate_slider_effect($id, $message) * @param string $callback A JS snippet to execute when the request is * successfully processed * - * @return string HTML code for the toggle button + * @return string HTML code for the toggle button */ function PMA_toggleButton($action, $select_name, $options, $callback) { @@ -2882,7 +2882,7 @@ function PMA_cacheUnset($var, $server = 0) * @param numeric $value coming from a BIT field * @param integer $length length * - * @return string the printable value + * @return string the printable value */ function PMA_printable_bit_value($value, $length) { @@ -2899,7 +2899,7 @@ function PMA_printable_bit_value($value, $length) * * @param string $value value * - * @return boolean + * @return boolean */ function PMA_contains_nonprintable_ascii($value) { @@ -2912,7 +2912,7 @@ function PMA_contains_nonprintable_ascii($value) * * @param string $bit_default_value value * - * @return string the converted value + * @return string the converted value */ function PMA_convert_bit_default_value($bit_default_value) { @@ -2924,7 +2924,7 @@ function PMA_convert_bit_default_value($bit_default_value) * * @param string $columnspec Column specification * - * @return array associative array containing type, spec_in_brackets + * @return array associative array containing type, spec_in_brackets * and possibly enum_set_values (another array) */ function PMA_extractColumnSpec($columnspec) @@ -3071,7 +3071,7 @@ function PMA_extractColumnSpec($columnspec) * * @param string $engine engine * - * @return boolean + * @return boolean */ function PMA_foreignkey_supported($engine) { @@ -3088,7 +3088,7 @@ function PMA_foreignkey_supported($engine) * * @param string $content content * - * @return string the content with characters replaced + * @return string the content with characters replaced */ function PMA_replace_binary_contents($content) { @@ -3132,7 +3132,7 @@ function PMA_asWKT($data, $includeSRID = false) * * @param string $string string * - * @return string with the chars replaced + * @return string with the chars replaced */ function PMA_duplicateFirstNewline($string) @@ -3385,7 +3385,7 @@ function PMA_selectUploadFile($import_list, $uploaddir) /** * Build titles and icons for action links * - * @return array the action titles + * @return array the action titles */ function PMA_buildActionTitles() { @@ -3419,7 +3419,7 @@ function PMA_buildActionTitles() * @param bool $html Whether to generate an html snippet or an array * @param string $selected The value to mark as selected in HTML mode * - * @return mixed An HTML snippet or an array of datatypes. + * @return mixed An HTML snippet or an array of datatypes. * */ function PMA_getSupportedDatatypes($html = false, $selected = '') @@ -3492,7 +3492,7 @@ function PMA_getSupportedDatatypes($html = false, $selected = '') * Returns a list of datatypes that are not (yet) handled by PMA. * Used by: tbl_change.php and libraries/db_routines.inc.php * - * @return array list of datatypes + * @return array list of datatypes */ function PMA_unsupportedDatatypes() { @@ -3670,7 +3670,7 @@ function PMA_getGISFunctions($geom_type = null, $binary = true, $display = false * @global array $analyzed_sql Analyzed SQL query * @global mixed $data data of currently edited row (used to detect whether to choose defaults) * - * @return string An HTML snippet of a dropdown list with function + * @return string An HTML snippet of a dropdown list with function * names appropriate for the requested column. */ function PMA_getFunctionsForField($field, $insert_mode) diff --git a/libraries/config/Form.class.php b/libraries/config/Form.class.php index 46306dc8df..c63be204d3 100644 --- a/libraries/config/Form.class.php +++ b/libraries/config/Form.class.php @@ -61,7 +61,7 @@ class Form * Returns type of given option * * @param string $option_name path or field name - * @return string|null one of: boolean, integer, double, string, select, array + * @return string|null one of: boolean, integer, double, string, select, array */ public function getOptionType($option_name) { @@ -75,7 +75,7 @@ class Form * Returns allowed values for select fields * * @param string $option_path - * @return array + * @return array */ public function getOptionValueList($option_path) { diff --git a/libraries/core.lib.php b/libraries/core.lib.php index 9c26b8af73..7183dfb7e3 100644 --- a/libraries/core.lib.php +++ b/libraries/core.lib.php @@ -36,7 +36,7 @@ if (! defined('PHPMYADMIN')) { * @param mixed $default default value * @param mixed $type var type or array of values to check against $var * - * @return mixed $var or $default + * @return mixed $var or $default * * @see PMA_isValid() */ @@ -86,7 +86,7 @@ function PMA_ifSetOr(&$var, $default = null, $type = 'similar') * @param mixed $type var type or array of valid values to check against $var * @param mixed $compare var to compare with $var * - * @return boolean whether valid or not + * @return boolean whether valid or not * * @todo add some more var types like hex, bin, ...? * @see http://php.net/gettype @@ -179,7 +179,7 @@ function PMA_isValid(&$var, $type = 'length', $compare = null) * * @param string $path The path to check * - * @return string The secured path + * @return string The secured path * * @access public */ @@ -201,7 +201,7 @@ function PMA_securePath($path) * @param string|array $message_args arguments applied to $error_message * @param boolean $delete_session whether to delete session cookie * - * @return exit + * @return exit */ function PMA_fatalError($error_message, $message_args = null, $delete_session = true) { @@ -242,7 +242,7 @@ function PMA_fatalError($error_message, $message_args = null, $delete_session = * * @param string $target anchor in documentation * - * @return string the URL + * @return string the URL * * @access public */ @@ -295,7 +295,7 @@ function PMA_warnMissingExtension($extension, $fatal = false, $extra = '') * * @param string $db database to count tables for * - * @return integer count of tables in $db + * @return integer count of tables in $db */ function PMA_getTableCount($db) { @@ -358,7 +358,7 @@ function PMA_get_real_size($size = 0) * @param array array to merge * @param array ... * - * @return array merged array + * @return array merged array * * @see http://php.net/array_merge * @see http://php.net/array_merge_recursive @@ -451,7 +451,7 @@ function PMA_arrayWalkRecursive(&$array, $function, $apply_to_keys_also = false) * @param string &$page page to check * @param array $whitelist whitelist to check page against * - * @return boolean whether $page is valid or not (in $whitelist or not) + * @return boolean whether $page is valid or not (in $whitelist or not) */ function PMA_checkPageValidity(&$page, $whitelist) { @@ -480,7 +480,7 @@ function PMA_checkPageValidity(&$page, $whitelist) * * @param string $var_name variable name * - * @return string value of $var or empty string + * @return string value of $var or empty string */ function PMA_getenv($var_name) { @@ -503,7 +503,7 @@ function PMA_getenv($var_name) * * @param string $uri the header to send * - * @return boolean always true + * @return boolean always true */ function PMA_sendHeaderLocation($uri) { diff --git a/libraries/database_interface.lib.php b/libraries/database_interface.lib.php index f69ebad293..c6ebbdce50 100644 --- a/libraries/database_interface.lib.php +++ b/libraries/database_interface.lib.php @@ -181,7 +181,7 @@ function PMA_DBI_try_query($query, $link = null, $options = 0, $cache_affected_r * * @param string $message the message * - * @return string $message + * @return string $message */ function PMA_DBI_convert_message($message) { @@ -282,7 +282,7 @@ function PMA_DBI_convert_message($message) * @param string $database name of database * @param mixed $link mysql link resource|object * - * @return array tables names + * @return array tables names */ function PMA_DBI_get_tables($database, $link = null) { @@ -301,7 +301,7 @@ function PMA_DBI_get_tables($database, $link = null) * @param string $a first argument to sort * @param string $b second argument to sort * - * @return integer a value representing whether $a should be before $b in the + * @return integer a value representing whether $a should be before $b in the * sorted array or not * * @access private @@ -349,7 +349,7 @@ function PMA_usort_comparison_callback($a, $b) * * @todo move into PMA_Table * - * @return array list of tables in given db(s) + * @return array list of tables in given db(s) */ function PMA_DBI_get_tables_full($database, $table = false, $tbl_is_group = false, $link = null, $limit_offset = 0, @@ -1034,7 +1034,7 @@ function PMA_DBI_get_columns_full($database = null, $table = null, * * @see PMA_DBI_get_columns() * - * @return string + * @return string */ function PMA_DBI_get_columns_sql($database, $table, $column = null, $full = false) { @@ -1096,7 +1096,7 @@ function PMA_DBI_get_columns_sql($database, $table, $column = null, $full = fals * @param boolean $full whether to return full info or only column names * @param mixed $link mysql link resource * - * @return false|array array indexed by column names or, + * @return false|array array indexed by column names or, * if $column is given, flat array description */ function PMA_DBI_get_columns($database, $table, $column = null, $full = false, $link = null) @@ -1146,7 +1146,7 @@ function PMA_DBI_get_columns($database, $table, $column = null, $full = false, $ * @param string $table name of table to retrieve columns from * @param mixed $link mysql link resource * - * @return null|array + * @return null|array */ function PMA_DBI_get_column_names($database, $table, $link = null) { @@ -1167,7 +1167,7 @@ function PMA_DBI_get_column_names($database, $table, $link = null) * @param string $table name of the table whose indexes are to be retreived * @param string $where additional conditions for WHERE * -* @return array $indexes +* @return array $indexes */ function PMA_DBI_get_table_indexes_sql($database, $table, $where = null) { @@ -1209,7 +1209,7 @@ function PMA_DBI_get_table_indexes_sql($database, $table, $where = null) * @param string $table name of the table whose indexes are to be retrieved * @param mixed $link mysql link resource * -* @return array $indexes +* @return array $indexes */ function PMA_DBI_get_table_indexes($database, $table, $link = null) { @@ -1229,7 +1229,7 @@ function PMA_DBI_get_table_indexes($database, $table, $link = null) * @param int $type PMA_DBI_GETVAR_SESSION|PMA_DBI_GETVAR_GLOBAL * @param mixed $link mysql link resource|object * - * @return mixed value for mysql server variable + * @return mixed value for mysql server variable */ function PMA_DBI_get_variable($var, $type = PMA_DBI_GETVAR_SESSION, $link = null) { diff --git a/libraries/dbi/mysql.dbi.lib.php b/libraries/dbi/mysql.dbi.lib.php index e6c3890c88..29a507b5f1 100644 --- a/libraries/dbi/mysql.dbi.lib.php +++ b/libraries/dbi/mysql.dbi.lib.php @@ -29,7 +29,7 @@ if (! defined('PMA_MYSQL_CLIENT_API')) { * @param string $password * @param int $client_flags * @param bool $persistent - * @return mixed false on error or a mysql connection resource on success + * @return mixed false on error or a mysql connection resource on success */ function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persistent = false) { @@ -431,7 +431,7 @@ function PMA_DBI_get_fields_meta($result) * return number of fields in given $result * * @param resource $result MySQL result - * @return int field count + * @return int field count */ function PMA_DBI_num_fields($result) { diff --git a/libraries/display_select_lang.lib.php b/libraries/display_select_lang.lib.php index 093f1aa6f9..c8d04de98a 100644 --- a/libraries/display_select_lang.lib.php +++ b/libraries/display_select_lang.lib.php @@ -15,7 +15,7 @@ if (! defined('PHPMYADMIN')) { * @param array &$a the array to be sorted * @param mixed &$b a required parameter * - * @return the sorted array + * @return the sorted array * @access private */ function PMA_language_cmp(&$a, &$b) diff --git a/libraries/display_tbl.lib.php b/libraries/display_tbl.lib.php index 13a5cf43f0..4b9358dd0a 100644 --- a/libraries/display_tbl.lib.php +++ b/libraries/display_tbl.lib.php @@ -38,7 +38,7 @@ require_once './libraries/Index.class.php'; * (just a copy of $unlim_num_rows if it exists, else * computed inside this function) * - * @return array an array with explicit indexes for all the display + * @return array an array with explicit indexes for all the display * elements * * @global string the database name @@ -471,7 +471,7 @@ function PMA_displayTableNavigation($pos_next, $pos_prev, $sql_query, $id_for_di * @param string $sort_expression_nodirection sort expression without direction * @param string $sort_direction sort direction * - * @return boolean $clause_is_unique + * @return boolean $clause_is_unique * * @global string $db the database name * @global string $table the table name @@ -1155,7 +1155,7 @@ function PMA_displayTableHeaders(&$is_display, &$fields_meta, $fields_cnt = 0, $ * @param bool $condition_field whether to add CSS class condition * @param string $value value to display * - * @return string the td + * @return string the td */ function PMA_buildValueDisplay($class, $condition_field, $value) { @@ -1170,7 +1170,7 @@ function PMA_buildValueDisplay($class, $condition_field, $value) * @param object $meta the meta-information about this field * @param string $align cell allignment * - * @return string the td + * @return string the td */ function PMA_buildNullDisplay($class, $condition_field, $meta, $align = '') { @@ -1186,7 +1186,7 @@ function PMA_buildNullDisplay($class, $condition_field, $meta, $align = '') * @param object $meta the meta-information about this field * @param string $align cell allignment * - * @return string the td + * @return string the td */ function PMA_buildEmptyDisplay($class, $condition_field, $meta, $align = '') { @@ -1246,7 +1246,7 @@ function PMA_addClass($class, $condition_field, $meta, $nowrap, $is_field_trunca * @param array $map the list of relations * @param array $analyzed_sql the analyzed query * - * @return boolean always true + * @return boolean always true * * @global string $db the database name * @global string $table the table name @@ -1841,7 +1841,7 @@ function PMA_displayTableBody(&$dt_result, &$is_display, $map, $analyzed_sql) /** * Do display the result table with the vertical direction mode. * - * @return boolean always true + * @return boolean always true * * @global array $vertical_display the information to display * @@ -2728,7 +2728,7 @@ function PMA_displayResultsOperations($the_disp_mode, $analyzed_sql) * @param object $meta the meta-information about this field * @param array $url_params parameters that should go to the download link * - * @return mixed string or float + * @return mixed string or float */ function PMA_handle_non_printable_contents($category, $content, $transform_function, $transform_options, $default_function, $meta, $url_params = array()) { @@ -2781,7 +2781,7 @@ function PMA_handle_non_printable_contents($category, $content, $transform_funct * @param array $transform_options array of options for transformation * @param bool $is_field_truncated whether the field is truncated * - * @return string formatted data + * @return string formatted data */ function PMA_prepare_row_data($class, $condition_field, $analyzed_sql, $meta, $map, $data, $transform_function, $default_function, $nowrap, $where_comparison, $transform_options, $is_field_truncated ) { @@ -2903,7 +2903,7 @@ function PMA_prepare_row_data($class, $condition_field, $analyzed_sql, $meta, $m * @param string $id_suffix suffix for the id * @param string $class css classes for the td element * - * @return string the generated HTML + * @return string the generated HTML */ function PMA_generateCheckboxForMulti($del_url, $is_display, $row_no, $where_clause_html, $condition_array, $del_query, $id_suffix, $class) @@ -2933,7 +2933,7 @@ function PMA_generateCheckboxForMulti($del_url, $is_display, $row_no, $where_cla * @param string $where_clause where cluase * @param string $where_clause_html url encoded where cluase * - * @return string the generated HTML + * @return string the generated HTML */ function PMA_generateEditLink($edit_url, $class, $edit_str, $where_clause, $where_clause_html) { @@ -2962,7 +2962,7 @@ function PMA_generateEditLink($edit_url, $class, $edit_str, $where_clause, $wher * @param string $where_clause_html url encoded where cluase * @param string $class css classes for the td element * - * @return string the generated HTML + * @return string the generated HTML */ function PMA_generateCopyLink($copy_url, $copy_str, $where_clause, $where_clause_html, $class) { @@ -2994,7 +2994,7 @@ function PMA_generateCopyLink($copy_url, $copy_str, $where_clause, $where_clause * @param string $js_conf text for the JS confirmation * @param string $class css classes for the td element * - * @return string the generated HTML + * @return string the generated HTML */ function PMA_generateDeleteLink($del_url, $del_str, $js_conf, $class) { @@ -3032,7 +3032,7 @@ function PMA_generateDeleteLink($del_url, $del_str, $js_conf, $class) * @param string $del_str text for the delete link * @param string $js_conf text for the JS confirmation * - * @return string the generated HTML + * @return string the generated HTML */ function PMA_generateCheckboxAndLinks($position, $del_url, $is_display, $row_no, $where_clause, $where_clause_html, $condition_array, $del_query, $id_suffix, $edit_url, $copy_url, $class, $edit_str, $copy_str, $del_str, $js_conf) { diff --git a/libraries/engines/bdb.lib.php b/libraries/engines/bdb.lib.php index 49dd262e98..12883ecdb3 100644 --- a/libraries/engines/bdb.lib.php +++ b/libraries/engines/bdb.lib.php @@ -14,7 +14,7 @@ if (! defined('PHPMYADMIN')) { class PMA_StorageEngine_bdb extends PMA_StorageEngine { /** - * @return array variable names + * @return array variable names */ function getVariables() { @@ -68,7 +68,7 @@ class PMA_StorageEngine_bdb extends PMA_StorageEngine * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { diff --git a/libraries/engines/binlog.lib.php b/libraries/engines/binlog.lib.php index 983509fc38..18f1badcf0 100644 --- a/libraries/engines/binlog.lib.php +++ b/libraries/engines/binlog.lib.php @@ -17,7 +17,7 @@ class PMA_StorageEngine_binlog extends PMA_StorageEngine * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { diff --git a/libraries/engines/innodb.lib.php b/libraries/engines/innodb.lib.php index d7524b71f4..214b6c715b 100644 --- a/libraries/engines/innodb.lib.php +++ b/libraries/engines/innodb.lib.php @@ -14,7 +14,7 @@ if (! defined('PHPMYADMIN')) { class PMA_StorageEngine_innodb extends PMA_StorageEngine { /** - * @return array + * @return array */ function getVariables() { @@ -114,7 +114,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine } /** - * @return string SQL query LIKE pattern + * @return string SQL query LIKE pattern */ function getVariablesLikePattern() { @@ -122,7 +122,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine } /** - * @return array detail pages + * @return array detail pages */ function getInfoPages() { @@ -138,7 +138,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine /** * returns html tables with stats over inno db buffer pool * - * @return string html table with stats + * @return string html table with stats */ function getPageBufferpool() { @@ -266,7 +266,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine /** * returns InnoDB status * - * @return string result of SHOW INNODB STATUS inside pre tags + * @return string result of SHOW INNODB STATUS inside pre tags */ function getPageStatus() { @@ -279,7 +279,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine * returns content for page $id * * @param string $id page id - * @return string html output + * @return string html output */ function getPage($id) { @@ -296,7 +296,7 @@ class PMA_StorageEngine_innodb extends PMA_StorageEngine * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { diff --git a/libraries/engines/memory.lib.php b/libraries/engines/memory.lib.php index f8bb0227cc..bdb1b987aa 100644 --- a/libraries/engines/memory.lib.php +++ b/libraries/engines/memory.lib.php @@ -16,7 +16,7 @@ class PMA_StorageEngine_memory extends PMA_StorageEngine /** * returns array with variable names dedicated to MyISAM storage engine * - * @return array variable names + * @return array variable names */ function getVariables() { diff --git a/libraries/engines/mrg_myisam.lib.php b/libraries/engines/mrg_myisam.lib.php index 87737f22fc..0acbc262d8 100644 --- a/libraries/engines/mrg_myisam.lib.php +++ b/libraries/engines/mrg_myisam.lib.php @@ -22,7 +22,7 @@ class PMA_StorageEngine_mrg_myisam extends PMA_StorageEngine_merge * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { diff --git a/libraries/engines/myisam.lib.php b/libraries/engines/myisam.lib.php index 3cd4790406..d4f6bcab93 100644 --- a/libraries/engines/myisam.lib.php +++ b/libraries/engines/myisam.lib.php @@ -16,7 +16,7 @@ class PMA_StorageEngine_myisam extends PMA_StorageEngine /** * returns array with variable names dedicated to MyISAM storage engine * - * @return array variable names + * @return array variable names */ function getVariables() { diff --git a/libraries/engines/ndbcluster.lib.php b/libraries/engines/ndbcluster.lib.php index 1ef34b74b4..77be2f32ce 100644 --- a/libraries/engines/ndbcluster.lib.php +++ b/libraries/engines/ndbcluster.lib.php @@ -14,7 +14,7 @@ if (! defined('PHPMYADMIN')) { class PMA_StorageEngine_ndbcluster extends PMA_StorageEngine { /** - * @return array + * @return array */ function getVariables() { @@ -25,7 +25,7 @@ class PMA_StorageEngine_ndbcluster extends PMA_StorageEngine } /** - * @return string SQL query LIKE pattern + * @return string SQL query LIKE pattern */ function getVariablesLikePattern() { @@ -36,7 +36,7 @@ class PMA_StorageEngine_ndbcluster extends PMA_StorageEngine * returns string with filename for the MySQL helppage * about this storage engne * - * @return string mysql helppage filename + * @return string mysql helppage filename */ function getMysqlHelpPage() { diff --git a/libraries/engines/pbxt.lib.php b/libraries/engines/pbxt.lib.php index 79b666aae5..a6ab0d959a 100644 --- a/libraries/engines/pbxt.lib.php +++ b/libraries/engines/pbxt.lib.php @@ -16,7 +16,7 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine /** * returns array with variable names dedicated to PBXT storage engine * - * @return array variable names + * @return array variable names */ function getVariables() { diff --git a/libraries/export/codegen.php b/libraries/export/codegen.php index b8372a5536..f04d1ed920 100644 --- a/libraries/export/codegen.php +++ b/libraries/export/codegen.php @@ -49,7 +49,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -61,7 +61,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -74,7 +74,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -87,7 +87,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -100,7 +100,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -117,7 +117,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/csv.php b/libraries/export/csv.php index deb8538438..122bf4879c 100644 --- a/libraries/export/csv.php +++ b/libraries/export/csv.php @@ -38,7 +38,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -50,7 +50,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -99,7 +99,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -112,7 +112,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -125,7 +125,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -142,7 +142,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/htmlword.php b/libraries/export/htmlword.php index 81f905f0ce..d42f1123c4 100644 --- a/libraries/export/htmlword.php +++ b/libraries/export/htmlword.php @@ -37,7 +37,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -49,7 +49,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -74,7 +74,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -87,7 +87,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -100,7 +100,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -117,7 +117,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -430,7 +430,7 @@ if (isset($plugin_list)) { * @param bool $dates whether to include creation/update/check dates * @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in' * @param string $export_type 'server', 'database', 'table' - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/json.php b/libraries/export/json.php index 46e7557f1c..8fdc4bb87f 100644 --- a/libraries/export/json.php +++ b/libraries/export/json.php @@ -37,7 +37,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -49,7 +49,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -68,7 +68,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -82,7 +82,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -95,7 +95,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -112,7 +112,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/latex.php b/libraries/export/latex.php index 3cac1e5a7b..b0b5e0f92d 100644 --- a/libraries/export/latex.php +++ b/libraries/export/latex.php @@ -87,7 +87,7 @@ if (isset($plugin_list)) { * * @param string $string the string to convert * - * @return string the converted string with escape codes + * @return string the converted string with escape codes * * @access private */ @@ -104,7 +104,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/mediawiki.php b/libraries/export/mediawiki.php index 23e7e2dc9e..7493def537 100644 --- a/libraries/export/mediawiki.php +++ b/libraries/export/mediawiki.php @@ -100,7 +100,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -112,7 +112,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -126,7 +126,7 @@ if (isset($plugin_list)) { * * @param string $db Database name * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -140,7 +140,7 @@ if (isset($plugin_list)) { * * @param string $db Database name * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -154,7 +154,7 @@ if (isset($plugin_list)) { * * @param string $db Database name * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -269,7 +269,7 @@ if (isset($plugin_list)) { * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/ods.php b/libraries/export/ods.php index e9728cd8b7..54abd5d6b4 100644 --- a/libraries/export/ods.php +++ b/libraries/export/ods.php @@ -36,7 +36,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -54,7 +54,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -105,7 +105,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -118,7 +118,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -131,7 +131,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -148,7 +148,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/pdf.php b/libraries/export/pdf.php index cd097067e5..c5eb428a04 100644 --- a/libraries/export/pdf.php +++ b/libraries/export/pdf.php @@ -348,7 +348,7 @@ if (isset($plugin_list)) { /** * Finalize the pdf. * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -367,7 +367,7 @@ if (isset($plugin_list)) { /** * Initialize the pdf to export data. * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/php_array.php b/libraries/export/php_array.php index e40145df2e..6555a00b7e 100644 --- a/libraries/export/php_array.php +++ b/libraries/export/php_array.php @@ -37,7 +37,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -49,7 +49,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -69,7 +69,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -83,7 +83,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -96,7 +96,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -113,7 +113,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/texytext.php b/libraries/export/texytext.php index b24509dfcf..0d834c9669 100644 --- a/libraries/export/texytext.php +++ b/libraries/export/texytext.php @@ -35,7 +35,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -47,7 +47,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -60,7 +60,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -73,7 +73,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -86,7 +86,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -103,7 +103,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -425,7 +425,7 @@ if (isset($plugin_list)) { * @param bool $dates whether to include creation/update/check dates * @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in' * @param string $export_type 'server', 'database', 'table' - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/xml.php b/libraries/export/xml.php index 018dce1551..ca2331fe2e 100644 --- a/libraries/export/xml.php +++ b/libraries/export/xml.php @@ -85,7 +85,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -99,7 +99,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -280,7 +280,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -304,7 +304,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -323,7 +323,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -340,7 +340,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/export/yaml.php b/libraries/export/yaml.php index 8c4695aa73..60ca7b45f8 100644 --- a/libraries/export/yaml.php +++ b/libraries/export/yaml.php @@ -38,7 +38,7 @@ if (isset($plugin_list)) { /** * Outputs export footer * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -51,7 +51,7 @@ if (isset($plugin_list)) { /** * Outputs export header * - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -65,7 +65,7 @@ if (isset($plugin_list)) { * Outputs database header * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -78,7 +78,7 @@ if (isset($plugin_list)) { * Outputs database footer * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -91,7 +91,7 @@ if (isset($plugin_list)) { * Outputs CREATE DATABASE statement * * @param string $db Database name - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ @@ -108,7 +108,7 @@ if (isset($plugin_list)) { * @param string $crlf the end of line sequence * @param string $error_url the url to go back in case of error * @param string $sql_query SQL query for obtaining data - * @return bool Whether it succeeded + * @return bool Whether it succeeded * * @access public */ diff --git a/libraries/iconv_wrapper.lib.php b/libraries/iconv_wrapper.lib.php index e57b5d21a0..d12265a25e 100644 --- a/libraries/iconv_wrapper.lib.php +++ b/libraries/iconv_wrapper.lib.php @@ -44,7 +44,7 @@ $gnu_iconv_to_aix_iconv_codepage_map = array ( * @param string $out_charset output character set * @param string $str the string to convert * - * @return mixed converted string or false on failure + * @return mixed converted string or false on failure * * @access public * diff --git a/libraries/import.lib.php b/libraries/import.lib.php index c532ff8857..d23633e61e 100644 --- a/libraries/import.lib.php +++ b/libraries/import.lib.php @@ -343,7 +343,7 @@ function PMA_importGetNextChunk($size = 32768) * @access public * * @param int $num - * @return string The column's "Excel" name + * @return string The column's "Excel" name */ function PMA_getColumnAlphaName($num) { @@ -389,7 +389,7 @@ function PMA_getColumnAlphaName($num) * * @param string $name column name(i.e. "A", or "BC", etc.) * - * @return int The column number + * @return int The column number * @access public */ function PMA_getColumnNumberFromName($name) @@ -451,7 +451,7 @@ define("FORMATTEDSQL", 2); * * @param string $last_cumulative_size * - * @return int Precision of the given decimal size notation + * @return int Precision of the given decimal size notation * @access public */ function PMA_getM($last_cumulative_size) @@ -465,7 +465,7 @@ function PMA_getM($last_cumulative_size) * * @param string $last_cumulative_size * - * @return int Scale of the given decimal size notation + * @return int Scale of the given decimal size notation * @access public */ function PMA_getD($last_cumulative_size) @@ -482,7 +482,7 @@ function PMA_getD($last_cumulative_size) * * @param string &$cell cell content * - * @return array Contains the precision, scale, and full size + * @return array Contains the precision, scale, and full size * representation of the given decimal cell * @access public */ @@ -508,7 +508,7 @@ function PMA_getDecimalSize(&$cell) * (NONE or VARCHAR or DECIMAL or INT or BIGINT) * @param string &$cell The current cell * - * @return string Size of the given cell in the type-appropriate format + * @return string Size of the given cell in the type-appropriate format * @access public * * @todo Handle the error cases more elegantly @@ -722,7 +722,7 @@ function PMA_detectSize($last_cumulative_size, $last_cumulative_type, $curr_type * @param string &$cell String representation of the cell for which * a best-fit type is to be determined * - * @return int The MySQL type representation + * @return int The MySQL type representation * (VARCHAR or INT or BIGINT or DECIMAL or NONE) * @access public */ @@ -762,7 +762,7 @@ function PMA_detectType($last_cumulative_type, &$cell) * * @param array &$table array(string $table_name, array $col_names, array $rows) * - * @return array array(array $types, array $sizes) + * @return array array(array $types, array $sizes) * @access public * * @link http://wiki.phpmyadmin.net/pma/Import @@ -864,7 +864,7 @@ $import_notice = null; * @param array &$additional_sql Additional SQL statements to be executed * @param array $options Associative array of options * - * @return void + * @return void * @access public * * @link http://wiki.phpmyadmin.net/pma/Import diff --git a/libraries/ip_allow_deny.lib.php b/libraries/ip_allow_deny.lib.php index 6fa9a60768..e5ebcac560 100644 --- a/libraries/ip_allow_deny.lib.php +++ b/libraries/ip_allow_deny.lib.php @@ -15,7 +15,7 @@ if (! defined('PHPMYADMIN')) { /** * Gets the "true" IP address of the current user * - * @return string the ip of the user + * @return string the ip of the user * * @access private */ @@ -63,7 +63,7 @@ function PMA_getIp() * @param string $testRange string of IP range to match * @param string $ipToTest string of IP to test against range * - * @return boolean always true + * @return boolean always true * * @access public */ @@ -117,7 +117,7 @@ function PMA_ipMaskTest($testRange, $ipToTest) * * @param string $type 'allow' | 'deny' type of rule to match * - * @return bool Matched a rule ? + * @return bool Matched a rule ? * * @access public * diff --git a/libraries/js_escape.lib.php b/libraries/js_escape.lib.php index 1444665cb7..1c039905e2 100644 --- a/libraries/js_escape.lib.php +++ b/libraries/js_escape.lib.php @@ -19,7 +19,7 @@ if (! defined('PHPMYADMIN')) { * @param string $a_string the string to format * @param boolean $add_backquotes whether to add backquotes to the string or not * - * @return string the formatted string + * @return string the formatted string * * @access public */ @@ -46,7 +46,7 @@ function PMA_jsFormat($a_string = '', $add_backquotes = true) * * @param string $string the string to be escaped * - * @return string the escaped string + * @return string the escaped string */ function PMA_escapeJsString($string) { diff --git a/libraries/kanji-encoding.lib.php b/libraries/kanji-encoding.lib.php index e0d261363f..f78119f5e6 100644 --- a/libraries/kanji-encoding.lib.php +++ b/libraries/kanji-encoding.lib.php @@ -23,7 +23,7 @@ if (! defined('PHPMYADMIN')) { * @global string the current encoding code * @global string the available encoding codes list * - * @return boolean always true + * @return boolean always true */ function PMA_internal_enc_check() { @@ -46,7 +46,7 @@ function PMA_internal_enc_check() * * @global string the available encoding codes list * - * @return boolean always true + * @return boolean always true */ function PMA_change_enc_order() { @@ -73,7 +73,7 @@ function PMA_change_enc_order() * * @global string the available encoding codes list * - * @return string the converted string + * @return string the converted string */ function PMA_kanji_str_conv($str, $enc, $kana) { @@ -105,7 +105,7 @@ function PMA_kanji_str_conv($str, $enc, $kana) * @param string $enc the destination encoding code * @param string $kana set 'kana' convert to JIS-X208-kana * - * @return string the name of the converted file + * @return string the name of the converted file */ function PMA_kanji_file_conv($file, $enc, $kana) { @@ -137,7 +137,7 @@ function PMA_kanji_file_conv($file, $enc, $kana) * * @param string $spaces spaces character to prepend the output with * - * @return string xhtml code for the radio controls + * @return string xhtml code for the radio controls */ function PMA_set_enc_form($spaces) { diff --git a/libraries/mysql_charsets.lib.php b/libraries/mysql_charsets.lib.php index 4dafc0edb7..7ebb916ad3 100644 --- a/libraries/mysql_charsets.lib.php +++ b/libraries/mysql_charsets.lib.php @@ -163,7 +163,7 @@ function PMA_generateCharsetQueryPart($collation) * * @param string $db name of db * - * @return string collation of $db + * @return string collation of $db */ function PMA_getDbCollation($db) { @@ -192,7 +192,7 @@ function PMA_getDbCollation($db) /** * returns default server collation from show variables * - * @return string $server_collation + * @return string $server_collation */ function PMA_getServerCollation() { @@ -206,7 +206,7 @@ function PMA_getServerCollation() * * @param string $collation MySQL collation string * - * @return string collation description + * @return string collation description */ function PMA_getCollationDescr($collation) { diff --git a/libraries/ob.lib.php b/libraries/ob.lib.php index 72ad38efae..bb1b667038 100644 --- a/libraries/ob.lib.php +++ b/libraries/ob.lib.php @@ -21,7 +21,7 @@ if (! defined('PHPMYADMIN')) { * doing. * * @staticvar integer remember last calculated value - * @return integer the output buffer mode + * @return integer the output buffer mode */ function PMA_outBufferModeGet() { diff --git a/libraries/opendocument.lib.php b/libraries/opendocument.lib.php index 37ed281646..767493679b 100644 --- a/libraries/opendocument.lib.php +++ b/libraries/opendocument.lib.php @@ -26,7 +26,7 @@ $GLOBALS['OpenDocumentNS'] = 'xmlns:office="urn:oasis:names:tc:opendocument:xmln * @param string $mime desired MIME type * @param string $data document content * - * @return string OASIS OpenDocument data + * @return string OASIS OpenDocument data * * @access public */ diff --git a/libraries/plugin_interface.lib.php b/libraries/plugin_interface.lib.php index 7388c33c8e..98e5e3cfb1 100644 --- a/libraries/plugin_interface.lib.php +++ b/libraries/plugin_interface.lib.php @@ -13,7 +13,7 @@ * @param mixed $plugin_param parameter to plugin by which they can * decide whether they can work * - * @return array list of plugins + * @return array list of plugins */ function PMA_getPlugins($plugins_dir, $plugin_param) { @@ -39,7 +39,7 @@ function PMA_getPlugins($plugins_dir, $plugin_param) * * @param string $name for local string * - * @return string locale string for $name + * @return string locale string for $name */ function PMA_getString($name) { @@ -54,7 +54,7 @@ function PMA_getString($name) * $GLOBALS['cfg'][$section] for plugin * @param string $opt name of option * - * @return string hmtl input tag option 'checked' + * @return string hmtl input tag option 'checked' */ function PMA_pluginCheckboxCheck($section, $opt) { @@ -76,7 +76,7 @@ function PMA_pluginCheckboxCheck($section, $opt) * $GLOBALS['cfg'][$section] for plugin * @param string $opt name of option * - * @return string default value for option $opt + * @return string default value for option $opt */ function PMA_pluginGetDefault($section, $opt) { @@ -112,7 +112,7 @@ function PMA_pluginGetDefault($section, $opt) * @param array &$list array with plugin configuration defined in plugin file * @param string $cfgname name of config value, if none same as $name * - * @return string html select tag + * @return string html select tag */ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null) { @@ -153,7 +153,7 @@ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null) * @param string $id option id * @param array &$opt plugin option details * - * @return string table row with option + * @return string table row with option */ function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt) { @@ -261,7 +261,7 @@ function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt) * @param string $section name of config section in $GLOBALS['cfg'][$section] * @param array &$list array with plugin configuration defined in plugin file * - * @return string html fieldset with plugin options + * @return string html fieldset with plugin options */ function PMA_pluginGetOptions($section, &$list) { diff --git a/libraries/pmd_common.php b/libraries/pmd_common.php index 63e7cbc568..921b0e01ec 100644 --- a/libraries/pmd_common.php +++ b/libraries/pmd_common.php @@ -70,7 +70,7 @@ function get_tabs() /** * retrieves table column info * - * @return array table column nfo + * @return array table column nfo */ function get_tab_info() { @@ -160,7 +160,7 @@ function get_script_contr() } /** - * @return array unique or primary indizes + * @return array unique or primary indizes */ function get_pk_or_unique_keys() { @@ -172,7 +172,7 @@ function get_pk_or_unique_keys() * * @param boolean whether to include ony unique ones * - * @return array indizes + * @return array indizes */ function get_all_keys($unique_only = false) { @@ -199,7 +199,7 @@ function get_all_keys($unique_only = false) /** * * - * @return array ??? + * @return array ??? */ function get_script_tabs() { @@ -220,7 +220,7 @@ function get_script_tabs() } /** - * @return array table positions and sizes + * @return array table positions and sizes */ function get_tab_pos() { diff --git a/libraries/relation.lib.php b/libraries/relation.lib.php index 73fd93d70f..3f68302ec5 100644 --- a/libraries/relation.lib.php +++ b/libraries/relation.lib.php @@ -16,7 +16,7 @@ if (! defined('PHPMYADMIN')) { * @param boolean $show_error whether to display SQL error messages or not * @param int $options query options * - * @return integer the result set, or false if no result set + * @return integer the result set, or false if no result set * * @access public * @@ -55,7 +55,7 @@ function PMA_query_as_controluser($sql, $show_error = true, $options = 0) /** * @param bool $verbose whether to print diagnostic info * - * @return array $cfgRelation + * @return array $cfgRelation */ function PMA_getRelationsParam($verbose = false) { @@ -341,7 +341,7 @@ function PMA_printDiagMessageForParameter($parameter, $relation_parameter_set, $ * but added some stuff to check what will work * * @access protected - * @return array the relation parameters for the current user + * @return array the relation parameters for the current user */ function PMA__getRelationsParam() { @@ -487,7 +487,7 @@ function PMA__getRelationsParam() * @param string $column the name of the column to check for * @param string $source the source for foreign key information * - * @return array db,table,column + * @return array db,table,column * * @access public */ @@ -590,7 +590,7 @@ function PMA_getForeigners($db, $table, $column = '', $source = 'both') * @param string $db the name of the db to check for * @param string $table the name of the table to check for * - * @return string field name + * @return string field name * * @access public */ @@ -639,7 +639,7 @@ function PMA_getDisplayField($db, $table) * @param string $db the name of the db to check for * @param string $table the name of the table to check for * - * @return array [field_name] = comment + * @return array [field_name] = comment * * @access public */ @@ -669,7 +669,7 @@ function PMA_getComments($db, $table = '') * * @param string $db the name of the db to check for * - * @return string comment + * @return string comment * * @access public */ @@ -703,7 +703,7 @@ function PMA_getDbComment($db) * * @access public * - * @return string comment + * @return string comment */ function PMA_getDbComments() { @@ -735,7 +735,7 @@ function PMA_getDbComments() * @param string $db the name of the db * @param string $comment the value of the column * - * @return boolean true, if comment-query was made. + * @return boolean true, if comment-query was made. * * @access public */ @@ -842,7 +842,7 @@ function PMA_setHistory($db, $table, $username, $sqlquery) * * @param string $username the username * - * @return array list of history items + * @return array list of history items * * @access public */ @@ -912,7 +912,7 @@ function PMA_purgeHistory($username) * @param string $data the current data of the dropdown * @param string $mode the needed mode * - * @return array the <option value=""><option>s + * @return array the <option value=""><option>s * * @access protected */ @@ -977,7 +977,7 @@ function PMA__foreignDropdownBuild($foreign, $data, $mode) * @param string $data the current data of the dropdown (field in row) * @param int $max maximum number of items in the dropdown * - * @return string the <option value=""><option>s + * @return string the <option value=""><option>s * * @access public */ @@ -1058,7 +1058,7 @@ function PMA_foreignDropdown($disp_row, $foreign_field, $foreign_display, $data, * @param string $foreign_filter a possible filter * @param string $foreign_limit a possible LIMIT clause * - * @return array data about the foreign keys + * @return array data about the foreign keys * * @access public */ @@ -1139,7 +1139,7 @@ function PMA_getForeignData($foreigners, $field, $override_total, $foreign_filte * * @param string $from whether to go from master to foreign or vice versa * - * @return boolean always true + * @return boolean always true * * @global array $tab_left the list of tables that we still couldn't connect * @global array $tab_know the list of allready connected tables diff --git a/libraries/replication_gui.lib.php b/libraries/replication_gui.lib.php index 35970cd8e8..ca8ed5059f 100644 --- a/libraries/replication_gui.lib.php +++ b/libraries/replication_gui.lib.php @@ -202,7 +202,7 @@ function PMA_replication_print_slaves_table($hidden = false) /** * get the correct username and hostname lengths for this MySQL server * - * @return array username length, hostname length + * @return array username length, hostname length */ function PMA_replication_get_username_hostname_length() diff --git a/libraries/rte/rte_events.lib.php b/libraries/rte/rte_events.lib.php index 05f2f9453f..9d315f8b39 100644 --- a/libraries/rte/rte_events.lib.php +++ b/libraries/rte/rte_events.lib.php @@ -228,7 +228,7 @@ function PMA_EVN_handleEditor() /** * This function will generate the values that are required to for the editor * - * @return array Data necessary to create the editor. + * @return array Data necessary to create the editor. */ function PMA_EVN_getDataFromRequest() { @@ -263,7 +263,7 @@ function PMA_EVN_getDataFromRequest() * * @param string $name The name of the event. * - * @return array Data necessary to create the editor. + * @return array Data necessary to create the editor. */ function PMA_EVN_getDataFromName($name) { @@ -316,7 +316,7 @@ function PMA_EVN_getDataFromName($name) * PMA_EVN_getDataFromRequest() or * PMA_EVN_getDataFromName() * - * @return string HTML code for the editor. + * @return string HTML code for the editor. */ function PMA_EVN_getEditorForm($mode, $operation, $item) { @@ -502,7 +502,7 @@ function PMA_EVN_getEditorForm($mode, $operation, $item) /** * Composes the query necessary to create an event from an HTTP request. * - * @return string The CREATE EVENT query. + * @return string The CREATE EVENT query. */ function PMA_EVN_getQueryFromRequest() { diff --git a/libraries/rte/rte_footer.lib.php b/libraries/rte/rte_footer.lib.php index 50a291f6ef..c6186497a3 100644 --- a/libraries/rte/rte_footer.lib.php +++ b/libraries/rte/rte_footer.lib.php @@ -16,7 +16,7 @@ if (! defined('PHPMYADMIN')) { * @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 + * @return string An HTML snippet with the link to add a new item */ function PMA_RTE_getFooterLinks($docu, $priv, $name) { @@ -49,7 +49,7 @@ function PMA_RTE_getFooterLinks($docu, $priv, $name) /** * Creates a fieldset for adding a new routine, if the user has the privileges. * - * @return string HTML code with containing the fotter fieldset + * @return string HTML code with containing the fotter fieldset */ function PMA_RTN_getFooterLinks() { @@ -59,7 +59,7 @@ function PMA_RTN_getFooterLinks() /** * Creates a fieldset for adding a new trigger, if the user has the privileges. * - * @return string HTML code with containing the fotter fieldset + * @return string HTML code with containing the fotter fieldset */ function PMA_TRI_getFooterLinks() { @@ -69,7 +69,7 @@ function PMA_TRI_getFooterLinks() /** * Creates a fieldset for adding a new event, if the user has the privileges. * - * @return string HTML code with containing the fotter fieldset + * @return string HTML code with containing the fotter fieldset */ function PMA_EVN_getFooterLinks() { diff --git a/libraries/rte/rte_list.lib.php b/libraries/rte/rte_list.lib.php index d048f2dacd..8c82ce10c2 100644 --- a/libraries/rte/rte_list.lib.php +++ b/libraries/rte/rte_list.lib.php @@ -16,7 +16,7 @@ if (! defined('PHPMYADMIN')) { * @param string $type One of ['routine'|'trigger'|'event'] * @param array $items An array of items * - * @return string HTML code of the list of items + * @return string HTML code of the list of items */ function PMA_RTE_getList($type, $items) { @@ -124,7 +124,7 @@ function PMA_RTE_getList($type, $items) * @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 + * @return string HTML code of a row for the list of routines */ function PMA_RTN_getRowForList($routine, $rowclass = '') { @@ -233,7 +233,7 @@ function PMA_RTN_getRowForList($routine, $rowclass = '') * @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 + * @return string HTML code of a cell for the list of triggers */ function PMA_TRI_getRowForList($trigger, $rowclass = '') { @@ -302,7 +302,7 @@ function PMA_TRI_getRowForList($trigger, $rowclass = '') * @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 + * @return string HTML code of a cell for the list of events */ function PMA_EVN_getRowForList($event, $rowclass = '') { diff --git a/libraries/rte/rte_routines.lib.php b/libraries/rte/rte_routines.lib.php index 69c0017fea..d6bf61f1c1 100644 --- a/libraries/rte/rte_routines.lib.php +++ b/libraries/rte/rte_routines.lib.php @@ -78,7 +78,7 @@ function PMA_RTN_main() * * @param string $value A string containing one parameter of a routine * - * @return array Parsed information about the input parameter + * @return array Parsed information about the input parameter */ function PMA_RTN_parseOneParameter($value) { @@ -138,7 +138,7 @@ function PMA_RTN_parseOneParameter($value) * @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. + * @return array Information about the parameteres of a routine. */ function PMA_RTN_parseAllParameters($parsed_query, $routine_type) { @@ -203,7 +203,7 @@ function PMA_RTN_parseAllParameters($parsed_query, $routine_type) * * @param array $parsed_query Parsed query, returned by PMA_SQP_parse() * - * @return string The definer of a routine. + * @return string The definer of a routine. */ function PMA_RTN_parseRoutineDefiner($parsed_query) { @@ -389,7 +389,7 @@ function PMA_RTN_handleEditor() * the 'Add another parameter', 'Remove last parameter' and * 'Change routine type' functionalities when JS is disabled. * - * @return array Data necessary to create the routine editor. + * @return array Data necessary to create the routine editor. */ function PMA_RTN_getDataFromRequest() { @@ -505,7 +505,7 @@ function PMA_RTN_getDataFromRequest() * @param bool $all Whether to return all data or just * the info about parameters. * - * @return array Data necessary to create the routine editor. + * @return array Data necessary to create the routine editor. */ function PMA_RTN_getDataFromName($name, $type, $all = true) { @@ -630,7 +630,7 @@ function PMA_RTN_getDataFromName($name, $type, $all = true) * @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. + * @return string HTML code of one row of parameter table for the editor. */ function PMA_RTN_getParameterRow($routine = array(), $index = null, $class = '') { @@ -736,7 +736,7 @@ function PMA_RTN_getParameterRow($routine = array(), $index = null, $class = '') * PMA_RTN_getDataFromRequest() or * PMA_RTN_getDataFromName() * - * @return string HTML code for the editor. + * @return string HTML code for the editor. */ function PMA_RTN_getEditorForm($mode, $operation, $routine) { @@ -978,7 +978,7 @@ function PMA_RTN_getEditorForm($mode, $operation, $routine) /** * Composes the query necessary to create a routine from an HTTP request. * - * @return string The CREATE [ROUTINE | PROCEDURE] query. + * @return string The CREATE [ROUTINE | PROCEDURE] query. */ function PMA_RTN_getQueryFromRequest() { @@ -1334,7 +1334,7 @@ function PMA_RTN_handleExecute() * @param array $routine Data for the routine returned by * PMA_RTN_getDataFromName() * - * @return string HTML code for the routine execution dialog. + * @return string HTML code for the routine execution dialog. */ function PMA_RTN_getExecuteForm($routine) { diff --git a/libraries/rte/rte_triggers.lib.php b/libraries/rte/rte_triggers.lib.php index 16024cfceb..1683ddf6c2 100644 --- a/libraries/rte/rte_triggers.lib.php +++ b/libraries/rte/rte_triggers.lib.php @@ -203,7 +203,7 @@ function PMA_TRI_handleEditor() /** * This function will generate the values that are required to for the editor * - * @return array Data necessary to create the editor. + * @return array Data necessary to create the editor. */ function PMA_TRI_getDataFromRequest() { @@ -227,7 +227,7 @@ function PMA_TRI_getDataFromRequest() * * @param string $name The name of the trigger. * - * @return array Data necessary to create the editor. + * @return array Data necessary to create the editor. */ function PMA_TRI_getDataFromName($name) { @@ -265,7 +265,7 @@ function PMA_TRI_getDataFromName($name) * PMA_TRI_getDataFromRequest() or * PMA_TRI_getDataFromName() * - * @return string HTML code for the editor. + * @return string HTML code for the editor. */ function PMA_TRI_getEditorForm($mode, $item) { @@ -382,7 +382,7 @@ function PMA_TRI_getEditorForm($mode, $item) /** * Composes the query necessary to create a trigger from an HTTP request. * - * @return string The CREATE TRIGGER query. + * @return string The CREATE TRIGGER query. */ function PMA_TRI_getQueryFromRequest() { diff --git a/libraries/rte/rte_words.lib.php b/libraries/rte/rte_words.lib.php index ed40434dda..ea1aef3d27 100644 --- a/libraries/rte/rte_words.lib.php +++ b/libraries/rte/rte_words.lib.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { * * @param string $index The index of the string to get * - * @return string The requested string or an empty string, if not available + * @return string The requested string or an empty string, if not available */ function PMA_RTE_getWord($index) { diff --git a/libraries/sanitizing.lib.php b/libraries/sanitizing.lib.php index 917dd16f57..9188c59a98 100644 --- a/libraries/sanitizing.lib.php +++ b/libraries/sanitizing.lib.php @@ -88,7 +88,7 @@ function PMA_replaceBBLink($found) * @param boolean $escape whether to escape html in result * @param boolean $safe whether string is safe (can keep < and > chars) * - * @return string the sanitized message + * @return string the sanitized message */ function PMA_sanitize($message, $escape = false, $safe = false) { @@ -149,7 +149,7 @@ function PMA_sanitize($message, $escape = false, $safe = false) * * @param string $filename The filename * - * @return string the sanitized filename + * @return string the sanitized filename * */ function PMA_sanitize_filename($filename) diff --git a/libraries/select_lang.lib.php b/libraries/select_lang.lib.php index e72590e898..a2f1d34829 100644 --- a/libraries/select_lang.lib.php +++ b/libraries/select_lang.lib.php @@ -31,7 +31,7 @@ function PMA_langName($tmplang) /** * Tries to find the language to use * - * @return bool success if valid lang is found, otherwise false + * @return bool success if valid lang is found, otherwise false */ function PMA_langCheck() { @@ -112,7 +112,7 @@ function PMA_langCheck() * * @param string &$lang language to set * - * @return bool success + * @return bool success */ function PMA_langSet(&$lang) { @@ -133,7 +133,7 @@ function PMA_langSet(&$lang) * @param string $str string to analyze * @param integer $envType type of the PHP environment variable which value is $str * - * @return bool true on success, otherwise false + * @return bool true on success, otherwise false * * @access private */ diff --git a/libraries/sqlvalidator.lib.php b/libraries/sqlvalidator.lib.php index a8233a0f89..0f5ed9e112 100644 --- a/libraries/sqlvalidator.lib.php +++ b/libraries/sqlvalidator.lib.php @@ -51,7 +51,7 @@ if ($cfg['SQLValidator']['use'] == true) { * * @param string SQL query to validate * - * @return string Validator result string + * @return string Validator result string * * @global array The PMA configuration array */ diff --git a/libraries/string.lib.php b/libraries/string.lib.php index a4b73e0ed3..2a316a1733 100644 --- a/libraries/string.lib.php +++ b/libraries/string.lib.php @@ -41,7 +41,7 @@ if (@extension_loaded('ctype')) { * @param string string to check for * @param integer the character to check for * @param integer starting position in the string - * @return boolean whether the character is escaped or not + * @return boolean whether the character is escaped or not */ function PMA_STR_charIsEscaped($string, $pos, $start = 0) { @@ -72,7 +72,7 @@ function PMA_STR_charIsEscaped($string, $pos, $start = 0) * @param integer number to check for * @param integer lower bound * @param integer upper bound - * @return boolean whether the number is in the range or not + * @return boolean whether the number is in the range or not */ function PMA_STR_numberInRangeInclusive($num, $lower, $upper) { @@ -84,7 +84,7 @@ function PMA_STR_numberInRangeInclusive($num, $lower, $upper) * * @param string character to check for * @param boolean whether the dot character is valid or not - * @return boolean whether the character is an SQL identifier or not + * @return boolean whether the character is an SQL identifier or not */ function PMA_STR_isSqlIdentifier($c, $dot_is_valid = false) { diff --git a/libraries/string_mb.lib.php b/libraries/string_mb.lib.php index 02a8731119..f5bad7ba56 100644 --- a/libraries/string_mb.lib.php +++ b/libraries/string_mb.lib.php @@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) { * Returns length of string depending on current charset. * * @param string string to count - * @return int string length + * @return int string length */ function PMA_strlen($string) { @@ -33,7 +33,7 @@ function PMA_strlen($string) * @param string $string string to count * @param int $start start of substring * @param int $length length of substring - * @return string + * @return string */ function PMA_substr($string, $start, $length = 2147483647) { @@ -46,7 +46,7 @@ function PMA_substr($string, $start, $length = 2147483647) * @param string $haystack * @param string $needle * @param int $offset - * @return integer position of $needle in $haystack or false + * @return integer position of $needle in $haystack or false */ function PMA_strpos($haystack, $needle, $offset = 0) { @@ -57,7 +57,7 @@ function PMA_strpos($haystack, $needle, $offset = 0) * Make a string lowercase * * @param string $string - * @return string + * @return string */ function PMA_strtolower($string) { diff --git a/libraries/string_native.lib.php b/libraries/string_native.lib.php index 7e22b4911d..8f8ac2291f 100644 --- a/libraries/string_native.lib.php +++ b/libraries/string_native.lib.php @@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) { * Returns length of string depending on current charset. * * @param string string to count - * @return int string length + * @return int string length */ function PMA_strlen($string) { @@ -33,7 +33,7 @@ function PMA_strlen($string) * @param string $string string to count * @param int $start start of substring * @param int $length length of substring - * @return string + * @return string */ function PMA_substr($string, $start, $length = 2147483647) { @@ -46,7 +46,7 @@ function PMA_substr($string, $start, $length = 2147483647) * @param string $haystack * @param string $needle * @param int $offset - * @return integer position of $needle in $haystack or false + * @return integer position of $needle in $haystack or false */ function PMA_strpos($haystack, $needle, $offset = 0) { @@ -57,7 +57,7 @@ function PMA_strpos($haystack, $needle, $offset = 0) * Make a string lowercase * * @param string $string - * @return string + * @return string */ function PMA_strtolower($string) { diff --git a/libraries/string_type_ctype.lib.php b/libraries/string_type_ctype.lib.php index 227268d31a..af804b2aec 100644 --- a/libraries/string_type_ctype.lib.php +++ b/libraries/string_type_ctype.lib.php @@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) { * Checks if a character is an alphanumeric one * * @param string character to check for - * @return boolean whether the character is an alphanumeric one or not + * @return boolean whether the character is an alphanumeric one or not */ function PMA_STR_isAlnum($c) { @@ -31,7 +31,7 @@ function PMA_STR_isAlnum($c) * Checks if a character is an alphabetic one * * @param string character to check for - * @return boolean whether the character is an alphabetic one or not + * @return boolean whether the character is an alphabetic one or not */ function PMA_STR_isAlpha($c) { @@ -42,7 +42,7 @@ function PMA_STR_isAlpha($c) * Checks if a character is a digit * * @param string character to check for - * @return boolean whether the character is a digit or not + * @return boolean whether the character is a digit or not */ function PMA_STR_isDigit($c) { @@ -53,7 +53,7 @@ function PMA_STR_isDigit($c) * Checks if a character is an upper alphabetic one * * @param string character to check for - * @return boolean whether the character is an upper alphabetic one or not + * @return boolean whether the character is an upper alphabetic one or not */ function PMA_STR_isUpper($c) { @@ -65,7 +65,7 @@ function PMA_STR_isUpper($c) * Checks if a character is a lower alphabetic one * * @param string character to check for - * @return boolean whether the character is a lower alphabetic one or not + * @return boolean whether the character is a lower alphabetic one or not */ function PMA_STR_isLower($c) { @@ -76,7 +76,7 @@ function PMA_STR_isLower($c) * Checks if a character is a space one * * @param string character to check for - * @return boolean whether the character is a space one or not + * @return boolean whether the character is a space one or not */ function PMA_STR_isSpace($c) { @@ -87,7 +87,7 @@ function PMA_STR_isSpace($c) * Checks if a character is an hexadecimal digit * * @param string character to check for - * @return boolean whether the character is an hexadecimal digit or not + * @return boolean whether the character is an hexadecimal digit or not */ function PMA_STR_isHexDigit($c) { diff --git a/libraries/string_type_native.lib.php b/libraries/string_type_native.lib.php index 32952b1778..e6569cef60 100644 --- a/libraries/string_type_native.lib.php +++ b/libraries/string_type_native.lib.php @@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) { * Checks if a character is an alphanumeric one * * @param string character to check for - * @return boolean whether the character is an alphanumeric one or not + * @return boolean whether the character is an alphanumeric one or not */ function PMA_STR_isAlnum($c) { @@ -31,7 +31,7 @@ function PMA_STR_isAlnum($c) * Checks if a character is an alphabetic one * * @param string character to check for - * @return boolean whether the character is an alphabetic one or not + * @return boolean whether the character is an alphabetic one or not */ function PMA_STR_isAlpha($c) { @@ -42,7 +42,7 @@ function PMA_STR_isAlpha($c) * Checks if a character is a digit * * @param string character to check for - * @return boolean whether the character is a digit or not + * @return boolean whether the character is a digit or not */ function PMA_STR_isDigit($c) { @@ -57,7 +57,7 @@ function PMA_STR_isDigit($c) * Checks if a character is an upper alphabetic one * * @param string character to check for - * @return boolean whether the character is an upper alphabetic one or not + * @return boolean whether the character is an upper alphabetic one or not */ function PMA_STR_isUpper($c) { @@ -72,7 +72,7 @@ function PMA_STR_isUpper($c) * Checks if a character is a lower alphabetic one * * @param string character to check for - * @return boolean whether the character is a lower alphabetic one or not + * @return boolean whether the character is a lower alphabetic one or not */ function PMA_STR_isLower($c) { @@ -87,7 +87,7 @@ function PMA_STR_isLower($c) * Checks if a character is a space one * * @param string character to check for - * @return boolean whether the character is a space one or not + * @return boolean whether the character is a space one or not */ function PMA_STR_isSpace($c) { @@ -106,7 +106,7 @@ function PMA_STR_isSpace($c) * Checks if a character is an hexadecimal digit * * @param string character to check for - * @return boolean whether the character is an hexadecimal digit or not + * @return boolean whether the character is an hexadecimal digit or not */ function PMA_STR_isHexDigit($c) { diff --git a/libraries/transformations.lib.php b/libraries/transformations.lib.php index aab0377654..5649b83fa6 100644 --- a/libraries/transformations.lib.php +++ b/libraries/transformations.lib.php @@ -77,7 +77,7 @@ function PMA_transformation_getOptions($option_string) * * @access public * @staticvar array mimetypes - * @return array array[mimetype], array[transformation] + * @return array array[mimetype], array[transformation] */ function PMA_getAvailableMIMEtypes() { @@ -204,7 +204,7 @@ function PMA_getMIME($db, $table, $strict = false) * * @access public * - * @return boolean true, if comment-query was made. + * @return boolean true, if comment-query was made. */ function PMA_setMIME($db, $table, $key, $mimetype, $transformation, $transformation_options, $forcedelete = false diff --git a/libraries/url_generating.lib.php b/libraries/url_generating.lib.php index 3745a9a5c1..4cd1d09fb0 100644 --- a/libraries/url_generating.lib.php +++ b/libraries/url_generating.lib.php @@ -21,7 +21,7 @@ if (! defined('PHPMYADMIN')) { * * @see PMA_generate_common_url() * - * @return string string with input fields + * @return string string with input fields * * @global string the current language * @global string the current conversion charset @@ -179,7 +179,7 @@ function PMA_getHiddenFields($values, $pre = '') * - if first param is not array: optional character to use * instead of '&' for dividing URL parameters * - * @return string string with URL parameters + * @return string string with URL parameters * @access public */ function PMA_generate_common_url() @@ -266,7 +266,7 @@ function PMA_generate_common_url() * @param string $encode whether to encode separator or not, * currently 'none' or 'html' * - * @return string character used for separating url parts usally ; or & + * @return string character used for separating url parts usally ; or & * @access public */ function PMA_get_arg_separator($encode = 'none') diff --git a/libraries/zip.lib.php b/libraries/zip.lib.php index bb06f448ca..613c88cc81 100644 --- a/libraries/zip.lib.php +++ b/libraries/zip.lib.php @@ -183,7 +183,7 @@ class zipfile /** * Echo central dir if ->doWrite==true, else build string to return * - * @return string if ->doWrite {empty string} else the ZIP file contents + * @return string if ->doWrite {empty string} else the ZIP file contents * * @access public */ diff --git a/server_privileges.php b/server_privileges.php index f265af4261..0002c6afd4 100644 --- a/server_privileges.php +++ b/server_privileges.php @@ -222,7 +222,7 @@ function PMA_wildcardEscapeForGrant($dbname, $tablename) * * @param string $initial the user's initial * - * @return string the generated condition + * @return string the generated condition */ function PMA_rangeOfUsers($initial = '') { @@ -247,7 +247,7 @@ function PMA_rangeOfUsers($initial = '') * * @global resource $user_link the database connection * - * @return array + * @return array */ function PMA_extractPrivInfo($row = '', $enableHTML = false) { @@ -503,7 +503,7 @@ function PMA_displayColumnPrivs($columns, $row, $name_for_select, * @global array $cfg the phpMyAdmin configuration * @global ressource $user_link the database connection * - * @return void + * @return void */ function PMA_displayPrivTable($db = '*', $table = '*', $submit = true) { @@ -856,7 +856,7 @@ function PMA_displayPrivTable($db = '*', $table = '*', $submit = true) * @global array $cfg the phpMyAdmin configuration * @global ressource $user_link the database connection * - * @return void + * @return void */ function PMA_displayLoginInformationFields($mode = 'new') { diff --git a/tbl_relation.php b/tbl_relation.php index d58a7b2001..51930f3a81 100644 --- a/tbl_relation.php +++ b/tbl_relation.php @@ -69,7 +69,7 @@ $options_array = array( * @param array $choices Choices for dropdown * @param string $selected_value Selected value * - * @return string The existing value (for selected) + * @return string The existing value (for selected) * * @access public */ @@ -94,7 +94,7 @@ function PMA_generate_dropdown($dropdown_question, $select_name, $choices, $sele * * @param string $text original string * - * @return array containing the elements (and their surrounding backquotes) + * @return array containing the elements (and their surrounding backquotes) * * @access public */ diff --git a/tbl_tracking.php b/tbl_tracking.php index 0c2b4c460c..e4533da2b2 100644 --- a/tbl_tracking.php +++ b/tbl_tracking.php @@ -57,7 +57,7 @@ if (isset($_REQUEST['report_export'])) { * @param string "to" date * @param string users * - * @return array filtered entries + * @return array filtered entries * */ function PMA_filter_tracking($data, $filter_ts_from, $filter_ts_to, $filter_users) diff --git a/user_password.php b/user_password.php index 0da59297aa..332f5974fa 100644 --- a/user_password.php +++ b/user_password.php @@ -70,7 +70,7 @@ require './libraries/footer.inc.php'; * * @param array $change_password_message * @param string $sql_query - * @return void + * @return void */ function PMA_getChangePassMessage($change_password_message, $sql_query = '') { @@ -90,7 +90,7 @@ function PMA_getChangePassMessage($change_password_message, $sql_query = '') /** * Generate the message * - * @return array error value and message + * @return array error value and message */ function PMA_setChangePasswordMsg() { @@ -115,7 +115,7 @@ function PMA_setChangePasswordMsg() * @param string $password * @param string $message * @param array $change_password_message - * @return void + * @return void */ function PMA_changePassword($password, $message, $change_password_message) { @@ -133,7 +133,7 @@ function PMA_changePassword($password, $message, $change_password_message) /** * Generate the hashing function * - * @return string $hashing_function + * @return string $hashing_function */ function PMA_changePassHashingFunction() { @@ -152,7 +152,7 @@ function PMA_changePassHashingFunction() * @param array $_url_params * @param string $sql_query * @param string $hashing_function - * @return void + * @return void */ function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_query, $hashing_function) { @@ -167,7 +167,7 @@ function PMA_ChangePassUrlParamsAndSubmitQuery($password, $_url_params, $sql_que * * @param array $_url_params * @param string $password - * @return array $_url_params + * @return array $_url_params */ function PMA_changePassAuthType($_url_params, $password) { @@ -194,7 +194,7 @@ function PMA_changePassAuthType($_url_params, $password) * @param string $message * @param string $sql_query * @param array $_url_params - * @return void + * @return void */ function PMA_changePassDisplayPage($message, $sql_query, $_url_params) { |
