phpdoc

horde · Jan 13, 2015 · 688869f · 688869f
1 parent ae1adf9
commit 688869f
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 35 deletions.
diff --git a/framework/Core/lib/Horde/Script/File.php b/framework/Core/lib/Horde/Script/File.php
@@ -1,27 +1,36 @@
 <?php
 /**
- * This class represents a javascript script file to output to the browser.
- *
  * Copyright 2012-2015 Horde LLC (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @package  Core
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
+ */
+
+/**
+ * This class represents a javascript script file to output to the browser.
+ *
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
  *
- * @property string $app
- * @property string $file
- * @property string $full_path
- * @property string $hash  Hash value of this file.
- * @property integer $modified  Last modification time of the file.
- * @property string $path  Full filesystem path to script.
- * @property string $tag
- * @property string $tag_full
- * @property Horde_Url $url  URL to script.
- * @property Horde_Url $url_full  Full URL to script.
+ * @property-read string $app  Application.
+ * @property-read string $file  Filename.
+ * @property-read string $full_path  Full path to file on filesystem.
+ * @property-read string $hash  Hash value of this file.
+ * @property-read integer $modified  Last modification time of the file.
+ * @property-read string $path  Full filesystem path to script.
+ * @property integer $priority  Script priority
+ * @property-read string $tag  HTML script tag to relative URL.
+ * @property-read string $tag_full  HTML script tag to full URL.
+ * @property-read Horde_Url $url  URL to script.
+ * @property-read Horde_Url $url_full  Full URL to script.
  */
 class Horde_Script_File
 {

diff --git a/framework/Core/lib/Horde/Script/File/External.php b/framework/Core/lib/Horde/Script/File/External.php
@@ -1,16 +1,24 @@
 <?php
 /**
- * This class represents an external script file to include.
- *
  * Copyright 2012-2015 Horde LLC (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @package  Core
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
+ */
+
+/**
+ * This class represents an external script file to include.
+ *
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
  */
 class Horde_Script_File_External extends Horde_Script_File
 {

diff --git a/framework/Core/lib/Horde/Script/File/JsDir.php b/framework/Core/lib/Horde/Script/File/JsDir.php
@@ -1,17 +1,25 @@
 <?php
 /**
- * This class represents a javascript script file located in an application's
- * js/ directory.
- *
  * Copyright 2012-2015 Horde LLC (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @package  Core
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
+ */
+
+/**
+ * This class represents a javascript script file located in an application's
+ * js/ directory.
+ *
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
  */
 class Horde_Script_File_JsDir extends Horde_Script_File
 {

diff --git a/framework/Core/lib/Horde/Script/File/JsFramework.php b/framework/Core/lib/Horde/Script/File/JsFramework.php
@@ -1,16 +1,24 @@
 <?php
 /**
- * This class represents a framework-level javascript script fileW.
- *
  * Copyright 2012-2015 Horde LLC (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @package  Core
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
+ */
+
+/**
+ * This class represents a framework-level javascript script fileW.
+ *
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2012-2015 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Core
  */
 class Horde_Script_File_JsFramework extends Horde_Script_File_JsDir
 {