From f99643663c531a854aa0565ac46dcedcb06d8f62 Mon Sep 17 00:00:00 2001 From: momo-i Date: Thu, 3 Feb 2011 09:43:46 +0900 Subject: header comment modified for phpdoc --- admin/access.php | 2 +- admin/catalog.php | 2 +- admin/duplicates.php | 2 +- admin/export.php | 2 +- admin/flag.php | 2 +- admin/index.php | 2 +- admin/mail.php | 2 +- admin/modules.php | 2 +- admin/shout.php | 2 +- admin/system.php | 2 +- admin/users.php | 2 +- bin/catalog_update.inc | 4 +-- bin/delete_disabled.inc | 4 +-- bin/dump_album_art.inc | 4 +-- bin/fix_filenames.inc | 4 +-- bin/install/install-db.inc | 4 +-- bin/migrate_config.inc | 4 +-- bin/print_tags.inc | 4 +-- bin/sort_files.inc | 4 +-- bin/write_playlists.inc | 4 +-- bin/write_tags.inc | 4 +-- lib/batch.lib.php | 10 ++++++- lib/class/access.class.php | 2 +- lib/class/ajax.class.php | 2 +- lib/class/album.class.php | 2 +- lib/class/ampachemail.class.php | 2 +- lib/class/ampacherss.class.php | 2 +- lib/class/api.class.php | 2 +- lib/class/art.class.php | 2 +- lib/class/artist.class.php | 2 +- lib/class/browse.class.php | 2 +- lib/class/catalog.class.php | 2 +- lib/class/config.class.php | 2 +- lib/class/core.class.php | 2 +- lib/class/database_object.abstract.php | 2 +- lib/class/dba.class.php | 2 +- lib/class/democratic.class.php | 2 +- lib/class/error.class.php | 2 +- lib/class/flag.class.php | 2 +- lib/class/localplay.abstract.php | 2 +- lib/class/localplay.class.php | 2 +- lib/class/media.interface.php | 2 +- lib/class/playlist.class.php | 2 +- lib/class/plugin.class.php | 2 +- lib/class/preference.class.php | 2 +- lib/class/query.class.php | 2 +- lib/class/radio.class.php | 2 +- lib/class/random.class.php | 2 +- lib/class/rating.class.php | 2 +- lib/class/recommendation.class.php | 2 +- lib/class/registration.class.php | 2 +- lib/class/scrobbler.class.php | 2 +- lib/class/shoutbox.class.php | 2 +- lib/class/song.class.php | 2 +- lib/class/stats.class.php | 2 +- lib/class/stream.class.php | 2 +- lib/class/tag.class.php | 2 +- lib/class/tmpplaylist.class.php | 2 +- lib/class/update.class.php | 2 +- lib/class/user.class.php | 2 +- lib/class/vainfo.class.php | 2 +- lib/class/vauth.class.php | 2 +- lib/class/video.class.php | 2 +- lib/class/xmldata.class.php | 2 +- lib/debug.lib.php | 10 ++++++- lib/general.lib.php | 10 ++++++- lib/gettext.php | 10 ++++++- lib/init.php | 10 ++++++- lib/install.php | 10 ++++++- lib/log.lib.php | 10 ++++++- lib/preferences.php | 10 ++++++- lib/rating.lib.php | 10 ++++++- lib/search.php | 10 ++++++- lib/themes.php | 10 ++++++- lib/ui.lib.php | 10 ++++++- server/ajax.server.php | 49 +++++++++++++++++++++------------- server/browse.ajax.php | 49 +++++++++++++++++++++------------- server/democratic.ajax.php | 49 +++++++++++++++++++++------------- server/flag.ajax.php | 49 +++++++++++++++++++++------------- server/index.ajax.php | 49 +++++++++++++++++++++------------- server/localplay.ajax.php | 49 +++++++++++++++++++++------------- server/playlist.ajax.php | 49 +++++++++++++++++++++------------- server/random.ajax.php | 49 +++++++++++++++++++++------------- server/song.ajax.php | 49 +++++++++++++++++++++------------- server/stats.ajax.php | 49 +++++++++++++++++++++------------- server/stream.ajax.php | 49 +++++++++++++++++++++------------- server/tag.ajax.php | 49 +++++++++++++++++++++------------- server/xml.server.php | 48 ++++++++++++++++++++------------- 88 files changed, 571 insertions(+), 331 deletions(-) diff --git a/admin/access.php b/admin/access.php index 9bac011c..b85d7b10 100644 --- a/admin/access.php +++ b/admin/access.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/class/access.class.php b/lib/class/access.class.php index 659696e1..e0c75ab1 100644 --- a/lib/class/access.class.php +++ b/lib/class/access.class.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/general.lib.php b/lib/general.lib.php index 3e353574..973d6f8f 100644 --- a/lib/general.lib.php +++ b/lib/general.lib.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/gettext.php b/lib/gettext.php index be319e84..d4eb0224 100644 --- a/lib/gettext.php +++ b/lib/gettext.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/init.php b/lib/init.php index 8da4b3f9..d492dc8b 100644 --- a/lib/init.php +++ b/lib/init.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ // Use output buffering, this gains us a few things and diff --git a/lib/install.php b/lib/install.php index aff5e61d..a8a15408 100644 --- a/lib/install.php +++ b/lib/install.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/log.lib.php b/lib/log.lib.php index 317e64bb..a1ecc2d3 100644 --- a/lib/log.lib.php +++ b/lib/log.lib.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /* diff --git a/lib/preferences.php b/lib/preferences.php index f1e8dd9d..22e95153 100644 --- a/lib/preferences.php +++ b/lib/preferences.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /* diff --git a/lib/rating.lib.php b/lib/rating.lib.php index 9f0ea498..b251b9c4 100644 --- a/lib/rating.lib.php +++ b/lib/rating.lib.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/search.php b/lib/search.php index 00b6e01b..992b01d2 100644 --- a/lib/search.php +++ b/lib/search.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/themes.php b/lib/themes.php index f0505d51..db4fa17f 100644 --- a/lib/themes.php +++ b/lib/themes.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/lib/ui.lib.php b/lib/ui.lib.php index bdc1354c..d82c20f8 100644 --- a/lib/ui.lib.php +++ b/lib/ui.lib.php @@ -1,6 +1,6 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 */ /** diff --git a/server/ajax.server.php b/server/ajax.server.php index 631ca628..d815c809 100644 --- a/server/ajax.server.php +++ b/server/ajax.server.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /* Because this is accessed via Ajax we are going to allow the session_id * as part of the get request diff --git a/server/browse.ajax.php b/server/browse.ajax.php index 764e9955..60d3cb8d 100644 --- a/server/browse.ajax.php +++ b/server/browse.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/democratic.ajax.php b/server/democratic.ajax.php index 0d345119..a158dad0 100644 --- a/server/democratic.ajax.php +++ b/server/democratic.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/flag.ajax.php b/server/flag.ajax.php index 6573ebd4..18053189 100644 --- a/server/flag.ajax.php +++ b/server/flag.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/index.ajax.php b/server/index.ajax.php index e1cbedff..ae135c5c 100644 --- a/server/index.ajax.php +++ b/server/index.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/localplay.ajax.php b/server/localplay.ajax.php index c056539b..0d86d670 100644 --- a/server/localplay.ajax.php +++ b/server/localplay.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/playlist.ajax.php b/server/playlist.ajax.php index f22d9d0b..a3007ddc 100644 --- a/server/playlist.ajax.php +++ b/server/playlist.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/random.ajax.php b/server/random.ajax.php index 180ae757..3ae29660 100644 --- a/server/random.ajax.php +++ b/server/random.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/song.ajax.php b/server/song.ajax.php index 00015954..d0a87f14 100644 --- a/server/song.ajax.php +++ b/server/song.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/stats.ajax.php b/server/stats.ajax.php index fdf8cf8a..226c9d65 100644 --- a/server/stats.ajax.php +++ b/server/stats.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/stream.ajax.php b/server/stream.ajax.php index 50923698..d3cfbaad 100644 --- a/server/stream.ajax.php +++ b/server/stream.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/tag.ajax.php b/server/tag.ajax.php index e7242dde..d15db91b 100644 --- a/server/tag.ajax.php +++ b/server/tag.ajax.php @@ -1,24 +1,35 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Sub-Ajax page, requires AJAX_INCLUDE diff --git a/server/xml.server.php b/server/xml.server.php index e9380371..f996bedf 100644 --- a/server/xml.server.php +++ b/server/xml.server.php @@ -1,24 +1,36 @@ + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ -*/ /** * This is accessed remotly to allow outside scripts access to ampache information * as such it needs to verify the session id that is passed -- cgit