Skip to content
Browse files

Improves code documentation for phpDocumentor.

  • Loading branch information...
1 parent 3b49073 commit 7b3b481562886f115e19d8f16dad58746b4c3234 Jim Safley committed May 2, 2011
View
6 lib/Scripto.php
@@ -1,14 +1,20 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require the base Scripto exception.
+ */
require_once 'Scripto/Exception.php';
/**
* Represents a Scripto application. Serves as a connector object between the
* external system API and MediaWiki API.
+ *
+ * @package Scripto
*/
class Scripto
{
View
6 lib/Scripto/Adapter/Example.php
@@ -1,15 +1,19 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require the adapter interface.
+ */
require_once 'Scripto/Adapter/Interface.php';
/**
* An example adapter for a hypothetical CMS.
*
- * @see Scripto_Adapter_Interface
+ * @package Scripto
*/
class Scripto_Adapter_Example implements Scripto_Adapter_Interface
{
View
7 lib/Scripto/Adapter/Exception.php
@@ -1,10 +1,17 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require the base Scripto exception.
+ */
require_once 'Scripto/Exception.php';
+/**
+ * @package Scripto
+ */
class Scripto_Adapter_Exception extends Scripto_Exception
{}
View
6 lib/Scripto/Adapter/Interface.php
@@ -1,9 +1,15 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Interface for Scripto adapter classes.
+ *
+ * @package Scripto
+ */
interface Scripto_Adapter_Interface
{
/**
View
10 lib/Scripto/Document.php
@@ -1,15 +1,25 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require the base Scripto class.
+ */
require_once 'Scripto.php';
+
+/**
+ * Require the base Scripto exception.
+ */
require_once 'Scripto/Exception.php';
/**
* Represents a Scripto document. Serves as a connector object between the
* external system API and MediaWiki API.
+ *
+ * @package Scripto
*/
class Scripto_Document
{
View
4 lib/Scripto/Exception.php
@@ -1,8 +1,12 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * @package Scripto
+ */
class Scripto_Exception extends Exception
{}
View
9 lib/Scripto/Service/Exception.php
@@ -1,10 +1,19 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require the base Scripto exception.
+ */
require_once 'Scripto/Exception.php';
+/**
+ * Represents a Scripto_Service exception.
+ *
+ * @package Scripto
+ */
class Scripto_Service_Exception extends Scripto_Exception
{}
View
13 lib/Scripto/Service/MediaWiki.php
@@ -1,15 +1,24 @@
<?php
/**
+ * @package Scripto
* @copyright © 2010-2011, Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt
*/
+/**
+ * Require Zend_Service_Abstract.
+ */
require_once 'Zend/Service/Abstract.php';
-require_once 'Zend/Http/Cookie.php';
+
+/**
+ * Require the Scripto service exception.
+ */
require_once 'Scripto/Service/Exception.php';
/**
* MediaWIki API client.
+ *
+ * @package Scripto
*/
class Scripto_Service_MediaWiki extends Zend_Service_Abstract
{
@@ -86,6 +95,8 @@ class Scripto_Service_MediaWiki extends Zend_Service_Abstract
*/
public function __construct($apiUrl, $dbName, $passCookies = true)
{
+ require_once 'Zend/Http/Cookie.php';
+
$this->_dbName = (string) $dbName;
$this->_passCookies = (bool) $passCookies;

0 comments on commit 7b3b481

Please sign in to comment.
Something went wrong with that request. Please try again.