From 62a7eaf73dd460564c27497e111ae9b2dbcbfbb4 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Fri, 20 Apr 2012 13:17:39 -0400 Subject: [PATCH] Add package docblock options --- autoload.php | 5 +- classes/db_pdo.php | 8 +- classes/db_reg.php | 3 + classes/db_sql.php | 8 +- classes/db_util.php | 8 +- classes/query_builder.php | 5 +- classes/settings.php | 8 +- docs/classes.svg | 24 +- docs/classes/DB_PDO.html | 18 +- docs/classes/DB_Reg.html | 18 +- docs/classes/DB_SQL.html | 18 +- docs/classes/DB_Util.html | 18 +- docs/classes/Firebird.html | 18 +- docs/classes/Firebird_Result.html | 18 +- docs/classes/Firebird_SQL.html | 18 +- docs/classes/Firebird_Util.html | 18 +- docs/classes/MySQL.html | 24 +- docs/classes/MySQL_SQL.html | 18 +- docs/classes/MySQL_Util.html | 22 +- docs/classes/ODBC.html | 22 +- docs/classes/ODBC_SQL.html | 18 +- docs/classes/ODBC_Util.html | 18 +- docs/classes/PgSQL.html | 852 ++++ docs/classes/PgSQL_SQL.html | 302 ++ docs/classes/PgSQL_Util.html | 18 +- docs/classes/Query_Builder.html | 26 +- docs/classes/SQLite.html | 22 +- docs/classes/SQLite_SQL.html | 18 +- docs/classes/SQLite_Util.html | 18 +- docs/classes/Settings.html | 20 +- docs/classes/pgSQL.html | 22 +- docs/classes/pgSQL_SQL.html | 18 +- docs/deprecated.html | 8 +- docs/errors.html | 8 +- docs/graph_class.html | 8 +- docs/markers.html | 8 +- docs/namespaces/default.html | 36 +- docs/packages/.html | 8 +- docs/packages/Default.html | 233 +- docs/packages/Query.Drivers.html | 216 + docs/packages/Query.Helper Classes.html | 102 + docs/packages/Query.Query.html | 120 + docs/packages/Query.html | 321 ++ docs/structure.xml | 5910 +++++++++++----------- drivers/firebird/firebird_driver.php | 8 +- drivers/firebird/firebird_result.php | 7 +- drivers/firebird/firebird_sql.php | 8 +- drivers/firebird/firebird_util.php | 9 +- drivers/mysql/mysql_driver.php | 10 +- drivers/mysql/mysql_sql.php | 8 +- drivers/mysql/mysql_util.php | 10 +- drivers/odbc/odbc_driver.php | 8 +- drivers/odbc/odbc_sql.php | 8 +- drivers/odbc/odbc_util.php | 8 +- drivers/pgsql/pgsql_driver.php | 10 +- drivers/pgsql/pgsql_sql.php | 5 +- drivers/pgsql/pgsql_util.php | 8 +- drivers/sqlite/sqlite_driver.php | 8 +- drivers/sqlite/sqlite_sql.php | 8 +- drivers/sqlite/sqlite_util.php | 8 +- phpdoc.dist.xml | 4 + tests/core/db_qb_test.php | 5 +- tests/core/db_test.php | 5 +- tests/databases/firebird/firebird-qb.php | 5 +- tests/databases/firebird/firebird.php | 5 +- tests/databases/mysql/mysql-qb.php | 5 +- tests/databases/mysql/mysql.php | 5 +- tests/db_files/FB_TEST_DB.FDB | Bin 802816 -> 802816 bytes tests/index.php | 5 +- 69 files changed, 5483 insertions(+), 3316 deletions(-) create mode 100644 docs/classes/PgSQL.html create mode 100644 docs/classes/PgSQL_SQL.html create mode 100644 docs/packages/Query.Drivers.html create mode 100644 docs/packages/Query.Helper Classes.html create mode 100644 docs/packages/Query.Query.html create mode 100644 docs/packages/Query.html diff --git a/autoload.php b/autoload.php index 328e337..6d252cd 100644 --- a/autoload.php +++ b/autoload.php @@ -4,10 +4,11 @@ * * Free Query Builder / Database Abstraction Layer * - * @author Timothy J. Warren + * @package Query + * @author Timothy J. Warren * @copyright Copyright (c) 2012 * @link https://github.com/aviat4ion/Query - * @license http://philsturgeon.co.uk/code/dbad-license + * @license http://philsturgeon.co.uk/code/dbad-license */ // -------------------------------------------------------------------------- diff --git a/classes/db_pdo.php b/classes/db_pdo.php index 50ccec7..ef66996 100644 --- a/classes/db_pdo.php +++ b/classes/db_pdo.php @@ -4,10 +4,11 @@ * * Free Query Builder / Database Abstraction Layer * - * @author Timothy J. Warren + * @package Query + * @author Timothy J. Warren * @copyright Copyright (c) 2012 * @link https://github.com/aviat4ion/Query - * @license http://philsturgeon.co.uk/code/dbad-license + * @license http://philsturgeon.co.uk/code/dbad-license */ // -------------------------------------------------------------------------- @@ -16,6 +17,9 @@ * Base Database class * * Extends PDO to simplify cross-database issues + * + * @package Query + * @subpackage Query */ abstract class DB_PDO extends PDO { diff --git a/classes/db_reg.php b/classes/db_reg.php index c09fa9c..2b82459 100644 --- a/classes/db_reg.php +++ b/classes/db_reg.php @@ -17,6 +17,9 @@ * * Decouples the Settings class from the query builder * and organizes database connections + * + * @package Query + * @subpackage Helper Classes */ class DB_Reg { diff --git a/classes/db_sql.php b/classes/db_sql.php index 444ca47..30f3d18 100644 --- a/classes/db_sql.php +++ b/classes/db_sql.php @@ -4,16 +4,20 @@ * * Free Query Builder / Database Abstraction Layer * - * @author Timothy J. Warren + * @author Timothy J. Warren * @copyright Copyright (c) 2012 * @link https://github.com/aviat4ion/Query - * @license http://philsturgeon.co.uk/code/dbad-license + * @license http://philsturgeon.co.uk/code/dbad-license + * @package Query */ // -------------------------------------------------------------------------- /** * Abstract parent for database manipulation subclasses + * + * @package Query + * @subpackage Query */ abstract class DB_SQL { diff --git a/classes/db_util.php b/classes/db_util.php index 5dee866..fd3cc4c 100644 --- a/classes/db_util.php +++ b/classes/db_util.php @@ -4,16 +4,20 @@ * * Free Query Builder / Database Abstraction Layer * - * @author Timothy J. Warren + * @package Query + * @author Timothy J. Warren * @copyright Copyright (c) 2012 * @link https://github.com/aviat4ion/Query - * @license http://philsturgeon.co.uk/code/dbad-license + * @license http://philsturgeon.co.uk/code/dbad-license */ // -------------------------------------------------------------------------- /** * Abstract class defining database / table creation methods + * + * @package Query + * @subpackage Query */ abstract class DB_Util { diff --git a/classes/query_builder.php b/classes/query_builder.php index ddca64b..bbb66ea 100644 --- a/classes/query_builder.php +++ b/classes/query_builder.php @@ -15,6 +15,9 @@ /** * Convienience class for creating sql queries - also the class that * instantiates the specific db driver + * + * @package Query + * @subpackage Query */ class Query_Builder { @@ -507,7 +510,7 @@ class Query_Builder { * @param string $field * @param mixed $val * @param string $pos - * @return $this; + * @return $this */ public function or_not_like($field, $val, $pos='both') { diff --git a/classes/settings.php b/classes/settings.php index 41000d0..e087205 100644 --- a/classes/settings.php +++ b/classes/settings.php @@ -4,10 +4,11 @@ * * Free Query Builder / Database Abstraction Layer * - * @author Timothy J. Warren + * @package Query + * @author Timothy J. Warren * @copyright Copyright (c) 2012 * @link https://github.com/aviat4ion/Query - * @license http://philsturgeon.co.uk/code/dbad-license + * @license http://philsturgeon.co.uk/code/dbad-license */ // -------------------------------------------------------------------------- @@ -15,7 +16,8 @@ /** * Class for manipulating datbase connections, and miscellaneous settings * - * Use JSON for compatibility + * @package Query + * @subpackage Helper Classes */ class Settings { diff --git a/docs/classes.svg b/docs/classes.svg index f353ad1..bd8364c 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -74,15 +74,15 @@ DB_Util - -\\pgSQL_SQL - + +\\PgSQL_SQL + -pgSQL_SQL +PgSQL_SQL - -\\pgSQL_SQL->\\DB_SQL + +\\PgSQL_SQL->\\DB_SQL @@ -98,15 +98,15 @@ - -\\pgSQL - + +\\PgSQL + -pgSQL +PgSQL - -\\pgSQL->\\DB_PDO + +\\PgSQL->\\DB_PDO diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html index 8b46fc7..736631a 100644 --- a/docs/classes/DB_PDO.html +++ b/docs/classes/DB_PDO.html @@ -18,7 +18,11 @@ Query
  • - API Documentation
      + API Documentation

      • Base Database class

      Extends PDO to simplify cross-database issues

      + + + + + + + + + +
      packageQuery
      subpackageQuery

       Methods

      @@ -648,7 +662,7 @@ the connection/database
      + generated on 2012-04-20T13:15:56-04:00.
      diff --git a/docs/classes/DB_Reg.html b/docs/classes/DB_Reg.html index 715fc6e..de7f90b 100644 --- a/docs/classes/DB_Reg.html +++ b/docs/classes/DB_Reg.html @@ -18,7 +18,11 @@ Query
      • - API Documentation
          + API Documentation