The branch, master has been updated via ae8935acf3a89d1c577285e47eeeb65637a7b3ad (commit) from c23cc1b31f0c08fe5cf5daef57dbd6bc4d1af4f9 (commit)
- Log ----------------------------------------------------------------- commit ae8935acf3a89d1c577285e47eeeb65637a7b3ad Author: Michal Čihař mcihar@suse.cz Date: Wed Jun 22 08:58:18 2011 +0200
Remove some useless doctags
-----------------------------------------------------------------------
Summary of changes: libraries/schema/Dia_Relation_Schema.class.php | 35 +++++------ libraries/schema/Eps_Relation_Schema.class.php | 67 ++++++++++----------- libraries/schema/Export_Relation_Schema.class.php | 4 - libraries/schema/Pdf_Relation_Schema.class.php | 3 - libraries/schema/Svg_Relation_Schema.class.php | 49 +++++++-------- libraries/schema/User_Schema.class.php | 4 - libraries/schema/Visio_Relation_Schema.class.php | 37 +++++------ 7 files changed, 88 insertions(+), 111 deletions(-)
diff --git a/libraries/schema/Dia_Relation_Schema.class.php b/libraries/schema/Dia_Relation_Schema.class.php index 6cf77e3..f6050c7 100644 --- a/libraries/schema/Dia_Relation_Schema.class.php +++ b/libraries/schema/Dia_Relation_Schema.class.php @@ -11,9 +11,6 @@ include_once("Export_Relation_Schema.class.php"); * This Class inherits the XMLwriter class and * helps in developing structure of DIA Schema Export * - * @name PMA_DIA - * @copyright - * @license * @access public * @see http://php.net/manual/en/book.xmlwriter.php */ @@ -52,7 +49,7 @@ class PMA_DIA extends XMLWriter
/** * Starts Dia Document - * + * * dia document starts by first initializing dia:diagram tag * then dia:diagramdata contains all the attributes that needed * to define the document, then finally a Layer starts which @@ -144,7 +141,7 @@ class PMA_DIA extends XMLWriter $this->writeAttribute('name', 'Background'); $this->writeAttribute('visible', 'true'); $this->writeAttribute('active', 'true'); - + }
/** @@ -182,8 +179,8 @@ class PMA_DIA extends XMLWriter
/** * Table preferences/statistics - * - * This class preserves the table co-ordinates,fields + * + * This class preserves the table co-ordinates,fields * and helps in drawing/generating the Tables in dia XML document. * * @name Table_Stats @@ -191,7 +188,7 @@ class PMA_DIA extends XMLWriter * @license * @see PMA_DIA */ -class Table_Stats +class Table_Stats { /** * Defines properties @@ -226,7 +223,7 @@ class Table_Stats if (!$result || !PMA_DBI_num_rows($result)) { $dia->dieSchema($pageNumber,"DIA",sprintf(__('The %s table doesn't exist!'), $tableName)); } - /* + /* * load fields * check to see if it will load all fields or only the foreign keys */ @@ -431,9 +428,9 @@ class Table_Stats
/** * Relation preferences/statistics - * + * * This class fetches the table master and foreign fields positions - * and helps in generating the Table references and then connects + * and helps in generating the Table references and then connects * master table's master field to foreign table's foreign key * in dia XML document. * @@ -442,7 +439,7 @@ class Table_Stats * @license * @see PMA_DIA */ -class Relation_Stats +class Relation_Stats { /** * Defines properties @@ -484,7 +481,7 @@ class Relation_Stats /** * Each Table object have connection points * which is used to connect to other objects in Dia - * we detect the position of key in fields and + * we detect the position of key in fields and * then determines its left and right connection * points. * @@ -631,7 +628,7 @@ class Relation_Stats * * Purpose of this class is to generate the Dia XML Document * which is used for representing the database diagrams in Dia IDE - * This class uses Database Table and Reference Objects of Dia and with + * This class uses Database Table and Reference Objects of Dia and with * the combination of these objects actually helps in preparing Dia XML. * * Dia XML is generated by using XMLWriter php extension and this class @@ -736,8 +733,8 @@ class PMA_Dia_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws relation references - * - * connects master table's master field to + * + * connects master table's master field to * foreign table's forein field using Dia object * type Database - Reference * @@ -755,10 +752,10 @@ class PMA_Dia_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws tables - * - * Tables are generated using Dia object type Database - Table + * + * Tables are generated using Dia object type Database - Table * primary fields are underlined and bold in tables - * + * * @param boolean changeColor Whether to show color for tables text or not * @return void * @access private diff --git a/libraries/schema/Eps_Relation_Schema.class.php b/libraries/schema/Eps_Relation_Schema.class.php index 4f2f8cb..ca8699a 100644 --- a/libraries/schema/Eps_Relation_Schema.class.php +++ b/libraries/schema/Eps_Relation_Schema.class.php @@ -11,9 +11,6 @@ include_once("Export_Relation_Schema.class.php"); * This Class is EPS Library and * helps in developing structure of EPS Schema Export * - * @name PMA_EPS - * @copyright - * @license * @access public * @see http://php.net/manual/en/book.xmlwriter.php */ @@ -29,8 +26,8 @@ class PMA_EPS * * Upon instantiation This starts writing the EPS Document. * %!PS-Adobe-3.0 EPSF-3.0 This is the MUST first comment to include - * it shows/tells that the Post Script document is purely under - * Document Structuring Convention [DSC] and is Compliant + * it shows/tells that the Post Script document is purely under + * Document Structuring Convention [DSC] and is Compliant * Encapsulated Post Script Document * * @return void @@ -147,13 +144,13 @@ class PMA_EPS * drawing the lines from x,y source to x,y destination and set the * width of the line. lines helps in showing relationships of tables * - * @param integer x_from The x_from attribute defines the start + * @param integer x_from The x_from attribute defines the start left position of the element - * @param integer y_from The y_from attribute defines the start + * @param integer y_from The y_from attribute defines the start right position of the element - * @param integer x_to The x_to attribute defines the end + * @param integer x_to The x_to attribute defines the end left position of the element - * @param integer y_to The y_to attribute defines the end + * @param integer y_to The y_to attribute defines the end right position of the element * @param integer lineWidth sets the width of the line e.g 2 * @return void @@ -173,13 +170,13 @@ class PMA_EPS * drawing the rectangle from x,y source to x,y destination and set the * width of the line. rectangles drawn around the text shown of fields * - * @param integer x_from The x_from attribute defines the start + * @param integer x_from The x_from attribute defines the start left position of the element - * @param integer y_from The y_from attribute defines the start + * @param integer y_from The y_from attribute defines the start right position of the element - * @param integer x_to The x_to attribute defines the end + * @param integer x_to The x_to attribute defines the end left position of the element - * @param integer y_to The y_to attribute defines the end + * @param integer y_to The y_to attribute defines the end right position of the element * @param integer lineWidth sets the width of the line e.g 2 * @return void @@ -204,9 +201,9 @@ class PMA_EPS * them as x and y coordinates to which to move. The coordinates * specified become the current point. * - * @param integer x The x attribute defines the + * @param integer x The x attribute defines the left position of the element - * @param integer y The y attribute defines the + * @param integer y The y attribute defines the right position of the element * @return void * @access public @@ -232,9 +229,9 @@ class PMA_EPS * Output the text at specified co-ordinates * * @param string text The string to be displayed - * @param integer x The x attribute defines the + * @param integer x The x attribute defines the left position of the element - * @param integer y The y attribute defines the + * @param integer y The y attribute defines the right position of the element * @return void * @access public @@ -247,15 +244,15 @@ class PMA_EPS
/** * get width of string/text - * + * * EPS text width is calcualted depending on font name * and font size. It is very important to know the width of text * because rectangle is drawn around it. - * + * * This is a bit hardcore method. I didn't found any other better than this. * if someone found better than this. would love to hear that method * - * @param string text string that width will be calculated + * @param string text string that width will be calculated * @param integer font name of the font like Arial,sans-serif etc * @param integer fontSize size of font * @return integer width of the text @@ -345,8 +342,8 @@ class PMA_EPS
/** * Table preferences/statistics - * - * This class preserves the table co-ordinates,fields + * + * This class preserves the table co-ordinates,fields * and helps in drawing/generating the Tables in EPS. * * @name Table_Stats @@ -354,7 +351,7 @@ class PMA_EPS * @license * @see PMA_EPS */ -class Table_Stats +class Table_Stats { /** * Defines properties @@ -489,7 +486,7 @@ class Table_Stats /* * it is unknown what value must be added, because * table title is affected by the tabe width value - */ + */ while ($this->width < $eps->getStringWidth($this->_getTitle(),$font,$fontSize)) { $this->width += 7; } @@ -546,9 +543,9 @@ class Table_Stats
/** * Relation preferences/statistics - * + * * This class fetches the table master and foreign fields positions - * and helps in generating the Table references and then connects + * and helps in generating the Table references and then connects * master table's master field to foreign table's foreign key * in EPS document. * @@ -557,7 +554,7 @@ class Table_Stats * @license * @see PMA_EPS */ -class Relation_Stats +class Relation_Stats { /** * Defines properties @@ -701,7 +698,7 @@ class Relation_Stats 1 ); } -} +} /* * end of the "Relation_Stats" class */ @@ -711,12 +708,12 @@ class Relation_Stats * * Purpose of this class is to generate the EPS Document * which is used for representing the database diagrams. - * This class uses post script commands and with + * This class uses post script commands and with * the combination of these commands actually helps in preparing EPS Document. * * This class inherits Export_Relation_Schema class has common functionality added * to this class - * + * * @name Eps_Relation_Schema * @copyright * @license @@ -725,7 +722,7 @@ class PMA_Eps_Relation_Schema extends PMA_Export_Relation_Schema { private $tables = array(); private $_relations = array(); - + /** * The "PMA_EPS_Relation_Schema" constructor * @@ -753,9 +750,9 @@ class PMA_Eps_Relation_Schema extends PMA_Export_Relation_Schema $eps->setDate(date("j F Y, g:i a")); $eps->setOrientation($this->orientation); $eps->setFont('Verdana','10'); - - - + + + $alltables = $this->getAllTables($db,$this->pageNumber);
foreach ($alltables AS $table) { @@ -820,7 +817,7 @@ class PMA_Eps_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws relation arrows and lines - * connects master table's master field to + * connects master table's master field to * foreign table's forein field * * @param boolean changeColor Whether to use one color per relation or not diff --git a/libraries/schema/Export_Relation_Schema.class.php b/libraries/schema/Export_Relation_Schema.class.php index e75b3e8..6c9cca7 100644 --- a/libraries/schema/Export_Relation_Schema.class.php +++ b/libraries/schema/Export_Relation_Schema.class.php @@ -9,10 +9,6 @@ * This class is inherited by all schema classes * It contains those methods which are common in them * it works like factory pattern - * - * @name Export Relation Schema - * @copyright - * @license */
class PMA_Export_Relation_Schema diff --git a/libraries/schema/Pdf_Relation_Schema.class.php b/libraries/schema/Pdf_Relation_Schema.class.php index 41ebf57..36edd2c 100644 --- a/libraries/schema/Pdf_Relation_Schema.class.php +++ b/libraries/schema/Pdf_Relation_Schema.class.php @@ -19,9 +19,6 @@ require_once './libraries/tcpdf/tcpdf.php'; * Extends the "TCPDF" class and helps * in developing the structure of PDF Schema Export * - * @name PMA_PDF - * @copyright - * @license * @access public * @see TCPDF */ diff --git a/libraries/schema/Svg_Relation_Schema.class.php b/libraries/schema/Svg_Relation_Schema.class.php index c1ff0f1..03c8805 100644 --- a/libraries/schema/Svg_Relation_Schema.class.php +++ b/libraries/schema/Svg_Relation_Schema.class.php @@ -11,9 +11,6 @@ include_once("Export_Relation_Schema.class.php"); * This Class inherits the XMLwriter class and * helps in developing structure of SVG Schema Export * - * @name PMA_SVG - * @copyright - * @license * @access public * @see http://php.net/manual/en/book.xmlwriter.php */ @@ -124,7 +121,7 @@ class PMA_SVG extends XMLWriter
/** * Starts Svg Document - * + * * svg document starts by first initializing svg tag * which contains all the attributes and namespace that needed * to define the svg document @@ -146,7 +143,7 @@ class PMA_SVG extends XMLWriter
/** * Ends Svg Document - * + * * @return void * @access public * @see XMLWriter::endElement(),XMLWriter::endDocument() @@ -159,7 +156,7 @@ class PMA_SVG extends XMLWriter
/** * output Svg Document - * + * * svg document prompted to the user for download * Svg document saved in .svg extension and can be * easily changeable by using any svg IDE @@ -179,17 +176,17 @@ class PMA_SVG extends XMLWriter
/** * Draws Svg elements - * - * SVG has some predefined shape elements like rectangle & text + * + * SVG has some predefined shape elements like rectangle & text * and other elements who have x,y co-ordinates are drawn. * specify their width and height and can give styles too. * * @param string name Svg element name * @param integer x The x attribute defines the left position of the element - (e.g. x="0" places the element 0 pixels from the left of + (e.g. x="0" places the element 0 pixels from the left of the browser window) * @param integer y The y attribute defines the top position of the element - (e.g. y="0" places the element 0 pixels from the top of + (e.g. y="0" places the element 0 pixels from the top of the browser window) * @param integer width The width attribute defines the width the element * @param integer height The height attribute defines the height the element @@ -218,9 +215,9 @@ class PMA_SVG extends XMLWriter
/** * Draws Svg Line element - * + * * Svg line element is drawn for connecting the tables. - * arrows are also drawn by specify its start and ending + * arrows are also drawn by specify its start and ending * co-ordinates * * @param string name Svg element name i.e line @@ -247,14 +244,14 @@ class PMA_SVG extends XMLWriter
/** * get width of string/text - * + * * Svg text element width is calcualted depending on font name * and font size. It is very important to know the width of text * because rectangle is drawn around it. - * + * * This is a bit hardcore method. I didn't found any other than this. * - * @param string text string that width will be calculated + * @param string text string that width will be calculated * @param integer font name of the font like Arial,sans-serif etc * @param integer fontSize size of font * @return integer width of the text @@ -315,8 +312,8 @@ class PMA_SVG extends XMLWriter
/** * Table preferences/statistics - * - * This class preserves the table co-ordinates,fields + * + * This class preserves the table co-ordinates,fields * and helps in drawing/generating the Tables in SVG XML document. * * @name Table_Stats @@ -324,7 +321,7 @@ class PMA_SVG extends XMLWriter * @license * @see PMA_SVG */ -class Table_Stats +class Table_Stats { /** * Defines properties @@ -373,7 +370,7 @@ class Table_Stats * load fields * check to see if it will load all fields or only the foreign keys */ - + if ($showKeys) { $indexes = PMA_Index::getFromTable($this->_tableName, $db); $all_columns = array(); @@ -457,7 +454,7 @@ class Table_Stats /* * it is unknown what value must be added, because * table title is affected by the tabe width value - */ + */ while ($this->width < $svg->getStringWidth($this->_getTitle(),$font,$fontSize)) { $this->width += 7; } @@ -523,9 +520,9 @@ class Table_Stats
/** * Relation preferences/statistics - * + * * This class fetches the table master and foreign fields positions - * and helps in generating the Table references and then connects + * and helps in generating the Table references and then connects * master table's master field to foreign table's foreign key * in SVG XML document. * @@ -534,7 +531,7 @@ class Table_Stats * @license * @see PMA_SVG::printElementLine */ -class Relation_Stats +class Relation_Stats { /** * Defines properties @@ -676,7 +673,7 @@ class Relation_Stats 'fill:'.$color.';stroke:black;stroke-width:2;' ); } -} +} /* * end of the "Relation_Stats" class */ @@ -685,7 +682,7 @@ class Relation_Stats * Svg Relation Schema Class * * Purpose of this class is to generate the SVG XML Document because - * SVG defines the graphics in XML format which is used for representing + * SVG defines the graphics in XML format which is used for representing * the database diagrams as vector image. This class actually helps * in preparing SVG XML format. * @@ -818,7 +815,7 @@ class PMA_Svg_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws relation arrows and lines - * connects master table's master field to + * connects master table's master field to * foreign table's forein field * * @param boolean changeColor Whether to use one color per relation or not diff --git a/libraries/schema/User_Schema.class.php b/libraries/schema/User_Schema.class.php index 20af01e..98216fe 100644 --- a/libraries/schema/User_Schema.class.php +++ b/libraries/schema/User_Schema.class.php @@ -9,10 +9,6 @@ * This Class interacts with the user to gather the information * about their tables for which they want to export the relational schema * export options are shown to user from they can choose - * - * @name User_Schema - * @copyright - * @license */
class PMA_User_Schema diff --git a/libraries/schema/Visio_Relation_Schema.class.php b/libraries/schema/Visio_Relation_Schema.class.php index fb43401..f8d17e8 100644 --- a/libraries/schema/Visio_Relation_Schema.class.php +++ b/libraries/schema/Visio_Relation_Schema.class.php @@ -11,9 +11,6 @@ include_once("Export_Relation_Schema.class.php"); * This Class inherits the XMLwriter class and * helps in developing structure of MS Visio Schema Export * - * @name PMA_VISIO - * @copyright - * @license * @access public * @see http://php.net/manual/en/book.xmlwriter.php */ @@ -52,10 +49,10 @@ class PMA_VISIO extends XMLWriter
/** * Starts Visio XML .VDX Document - * + * * Visio XML document starts by first initializing VisioDocument tag - * then DocumentProperties & DocumentSettings contains all the - * attributes that needed to define the document. Order of elements + * then DocumentProperties & DocumentSettings contains all the + * attributes that needed to define the document. Order of elements * should be maintained while generating XML of Visio. * * @return void @@ -98,8 +95,8 @@ class PMA_VISIO extends XMLWriter
/** * Sets Visio XML .VDX Document Properties - * - * DocumentProperties tag contains document property elements such as + * + * DocumentProperties tag contains document property elements such as the document's Title,Subject,Creator and templates tags * * @return void @@ -119,8 +116,8 @@ class PMA_VISIO extends XMLWriter
/** * Sets Visio XML .VDX Document Settings - * - * DocumentSettings tag contains elements that specify document settings. + * + * DocumentSettings tag contains elements that specify document settings. * * @return void * @access private @@ -169,7 +166,7 @@ class PMA_VISIO extends XMLWriter /** * Draws tables schema */ -class Table_Stats +class Table_Stats { /** * Defines properties @@ -217,7 +214,7 @@ class Table_Stats * load fields * check to see if it will load all fields or only the foreign keys */ - + if ($showKeys) { $indexes = PMA_Index::getFromTable($this->_tableName, $db); $all_columns = array(); @@ -342,7 +339,7 @@ class Table_Stats * @access public * @see PMA_VISIO */ -class Relation_Stats +class Relation_Stats { /** * Defines properties @@ -450,11 +447,11 @@ class Relation_Stats } else { $color = 'black'; } - + // code here for making connections b/w relation objects
} -} +} /* * end of the "Relation_Stats" class */ @@ -470,7 +467,7 @@ class Relation_Stats * Visio XML is generated by using XMLWriter php extension and this class * inherits Export_Relation_Schema class has common functionality added * to this class - * + * * @name Visio_Relation_Schema * @copyright * @license @@ -561,8 +558,8 @@ class PMA_Visio_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws relation references - * - * connects master table's master field to + * + * connects master table's master field to * foreign table's forein field. * * @param boolean changeColor Whether to use one color per relation or not @@ -579,8 +576,8 @@ class PMA_Visio_Relation_Schema extends PMA_Export_Relation_Schema
/** * Draws tables - * - * + * + * * @param boolean changeColor Whether to show color for tables text or not * @return void * @access private
hooks/post-receive