From 0c80565d9c0cdfa6fd2465fcbe6959a3adb8c17b Mon Sep 17 00:00:00 2001
From: Yannick Warnier
Date: Sat, 23 Jul 2011 09:17:12 -0500
Subject: [PATCH] Minor - Adapting code comments to phpdoc
---
main/auth/courses.php | 5 +-
main/auth/inscription.php | 7 +-
main/auth/ldap/authldap.php | 5 +-
main/auth/ldap/ldap_var.inc.php | 32 ++-------
main/auth/ldap/login.php | 66 +++++--------------
main/auth/ldap/newUser.php | 50 ++++----------
main/auth/lostPassword.php | 5 +-
main/auth/lost_password.lib.php | 8 ++-
main/auth/my_progress.php | 9 ++-
main/auth/openid/login.php | 4 +-
main/auth/openid/openid.conf.php | 7 +-
main/auth/openid/openid.lib.php | 6 +-
main/auth/openid/whatis.php | 10 ++-
main/auth/openid/xrds.lib.php | 7 +-
main/auth/profile.php | 5 +-
main/auth/sso/sso.class.php | 2 +
main/chat/chat.php | 7 ++
main/chat/chat_chat.php | 3 +
main/chat/chat_hidden.php | 3 +
main/chat/chat_message.php | 5 +-
main/chat/chat_whoisonline.php | 5 +-
main/chat/header_frame.inc.php | 5 +-
main/create_course/add_course.php | 3 +
main/document/create_audio.php | 5 +-
main/document/create_document.php | 7 +-
main/document/create_draw.php | 7 +-
main/document/create_paint.php | 8 ++-
main/document/document.inc.php | 9 +--
main/document/document.php | 6 +-
main/document/document_slideshow.inc.php | 17 ++---
main/document/download.php | 16 ++---
main/document/downloadfolder.inc.php | 5 +-
main/document/edit_document.php | 5 +-
main/document/edit_draw.php | 5 +-
main/document/edit_paint.php | 6 +-
main/document/exit_pixlr.php | 5 +-
main/document/footerpage.php | 5 +-
main/document/headerpage.php | 5 +-
main/document/quota.php | 3 +
main/document/record_audio.php | 5 +-
main/document/save_pixlr.php | 7 +-
main/document/showinframes.php | 13 ++--
main/document/showinframesmin.php | 9 +--
main/document/slideshow.php | 15 +++--
main/document/slideshowoptions.php | 49 ++++++--------
main/document/upload.php | 7 +-
main/messages/download.php | 7 +-
main/messages/inbox.php | 6 +-
main/messages/index.php | 6 +-
main/messages/outbox.php | 6 +-
main/messages/send_message.php | 6 +-
.../send_message_to_userfriend.inc.php | 5 +-
main/messages/view_message.php | 6 +-
main/user/subscribe_user.php | 5 +-
main/user/user_add.php | 5 +-
55 files changed, 279 insertions(+), 251 deletions(-)
mode change 100644 => 100755 main/auth/ldap/login.php
mode change 100644 => 100755 main/auth/ldap/newUser.php
mode change 100644 => 100755 main/auth/openid/login.php
mode change 100644 => 100755 main/auth/openid/openid.lib.php
mode change 100644 => 100755 main/auth/openid/whatis.php
mode change 100644 => 100755 main/chat/chat_chat.php
mode change 100644 => 100755 main/messages/index.php
mode change 100644 => 100755 main/messages/send_message.php
diff --git a/main/auth/courses.php b/main/auth/courses.php
index 7e95172fd9..6f456e2c95 100755
--- a/main/auth/courses.php
+++ b/main/auth/courses.php
@@ -1,12 +1,13 @@
- Beeznest
* @package chamilo.auth
*/
-
+/**
+ * Code
+ */
// Names of the language file that needs to be included.
$language_file = array ('courses', 'registration');
diff --git a/main/auth/inscription.php b/main/auth/inscription.php
index 28475c87fa..84109504f7 100755
--- a/main/auth/inscription.php
+++ b/main/auth/inscription.php
@@ -1,11 +1,12 @@
\ No newline at end of file
diff --git a/main/auth/ldap/login.php b/main/auth/ldap/login.php
old mode 100644
new mode 100755
index 0f481c0758..cd551226db
--- a/main/auth/ldap/login.php
+++ b/main/auth/ldap/login.php
@@ -1,54 +1,24 @@
\ No newline at end of file
+?>
diff --git a/main/auth/ldap/newUser.php b/main/auth/ldap/newUser.php
old mode 100644
new mode 100755
index 471455b33e..d943f078d1
--- a/main/auth/ldap/newUser.php
+++ b/main/auth/ldap/newUser.php
@@ -1,44 +1,16 @@
\ No newline at end of file
+?>
diff --git a/main/auth/lostPassword.php b/main/auth/lostPassword.php
index d5054fa5d9..dc1c8ff55c 100755
--- a/main/auth/lostPassword.php
+++ b/main/auth/lostPassword.php
@@ -14,6 +14,9 @@
*
* @package chamilo.auth
*/
+/**
+ * Code
+ */
// name of the language file that needs to be included
$language_file = 'registration';
@@ -98,4 +101,4 @@ if (isset ($_GET['reset']) && isset ($_GET['id'])) {
$form->display();
}
}
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/auth/lost_password.lib.php b/main/auth/lost_password.lib.php
index 885075ea8b..3af9b20ec6 100755
--- a/main/auth/lost_password.lib.php
+++ b/main/auth/lost_password.lib.php
@@ -1,6 +1,9 @@
code = $code;
return $result;
-}
\ No newline at end of file
+}
diff --git a/main/auth/openid/openid.conf.php b/main/auth/openid/openid.conf.php
index d7ac38d627..ab3e326759 100755
--- a/main/auth/openid/openid.conf.php
+++ b/main/auth/openid/openid.conf.php
@@ -1,9 +1,14 @@
OpenID is a secure way to use one user ID and password to log in to many web sites without special software, giving the same password to each site, or losing control over which information is shared with each site that you visit.
';
$langMainInfoDetail .= '
Users can create accounts using their OpenID, assign one or more OpenIDs to an existing account, and log in using an OpenID. This lowers the barrier to registration, which is good for the site, and offers convenience and security to the users. Logging in via OpenID is far more secure than cross-site logins using drupal.module.
';
$langMainInfoDetail .= '
More information on OpenID is available at OpenID.net
';
-?>
\ No newline at end of file
+?>
diff --git a/main/auth/openid/openid.lib.php b/main/auth/openid/openid.lib.php
old mode 100644
new mode 100755
index a927e59fd6..ec55d9f898
--- a/main/auth/openid/openid.lib.php
+++ b/main/auth/openid/openid.lib.php
@@ -1,9 +1,13 @@
@@ -16,4 +24,4 @@ Display::display_header('OpenID', NULL);
\ No newline at end of file
+?>
diff --git a/main/auth/openid/xrds.lib.php b/main/auth/openid/xrds.lib.php
index 4702c65015..52ca05cb30 100755
--- a/main/auth/openid/xrds.lib.php
+++ b/main/auth/openid/xrds.lib.php
@@ -1,6 +1,11 @@
';
$form->display();
}
-Display :: display_footer();
\ No newline at end of file
+Display :: display_footer();
diff --git a/main/auth/sso/sso.class.php b/main/auth/sso/sso.class.php
index 6e2536cea6..46b7d31f7e 100755
--- a/main/auth/sso/sso.class.php
+++ b/main/auth/sso/sso.class.php
@@ -1,4 +1,5 @@
- >
\ No newline at end of file
+ >
diff --git a/main/create_course/add_course.php b/main/create_course/add_course.php
index bb2a44a267..07c7049afc 100755
--- a/main/create_course/add_course.php
+++ b/main/create_course/add_course.php
@@ -11,6 +11,9 @@
* "Course validation" feature, technical adaptation for Chamilo 1.8.8:
* @author Ivan Tcholakov
*/
+/**
+ * Code
+ */
// Name of the language file that needs to be included.
$language_file = 'create_course';
diff --git a/main/document/create_audio.php b/main/document/create_audio.php
index a684132738..d25370150d 100644
--- a/main/document/create_audio.php
+++ b/main/document/create_audio.php
@@ -10,6 +10,9 @@
* @since 8/January/2011
* TODO:clean all file
*/
+/**
+ * Code
+ */
/* INIT SECTION */
$language_file = array('document');
@@ -501,4 +504,4 @@ function downloadMP3_pediaphone($filepath, $dir){
}
}
-?>
\ No newline at end of file
+?>
diff --git a/main/document/create_document.php b/main/document/create_document.php
index 33eb9c5961..63df0b37b6 100755
--- a/main/document/create_document.php
+++ b/main/document/create_document.php
@@ -1,12 +1,13 @@
validate()) {
echo '';
$form->display();
Display :: display_footer();
-}
\ No newline at end of file
+}
diff --git a/main/document/create_draw.php b/main/document/create_draw.php
index 4a83e908af..360769d56a 100644
--- a/main/document/create_draw.php
+++ b/main/document/create_draw.php
@@ -6,9 +6,12 @@
*
* @package chamilo.document
*
- * @author Juan Carlos Ra�a Trabado
+ * @author Juan Carlos Raña Trabado
* @since 25/september/2010
*/
+/**
+ * Code
+ */
/* INIT SECTION */
@@ -160,4 +163,4 @@ if (api_browser_support('svg')){
Display::display_error_message(get_lang('BrowserDontSupportsSVG'));
}
-Display :: display_footer();
\ No newline at end of file
+Display :: display_footer();
diff --git a/main/document/create_paint.php b/main/document/create_paint.php
index 140fbb25d9..b7191b029e 100644
--- a/main/document/create_paint.php
+++ b/main/document/create_paint.php
@@ -1,6 +1,5 @@
';
-echo '';
\ No newline at end of file
+echo '';
diff --git a/main/document/document.inc.php b/main/document/document.inc.php
index 8bf3bd951c..799ce5915f 100755
--- a/main/document/document.inc.php
+++ b/main/document/document.inc.php
@@ -1,8 +1,9 @@
'.Display::return_icon('back.png', get_lang('BackTo').' '.get_lang('DocumentsOverview'),'','32').'';
}
echo '';
-}
\ No newline at end of file
+}
diff --git a/main/document/edit_draw.php b/main/document/edit_draw.php
index 5e7f86bbcb..a2273fdffc 100644
--- a/main/document/edit_draw.php
+++ b/main/document/edit_draw.php
@@ -9,6 +9,9 @@
* @author Juan Carlos Ra�a Trabado
* @since 25/september/2010
*/
+/**
+ * Code
+ */
/* INIT SECTION */
@@ -120,4 +123,4 @@ if (api_browser_support('svg')) {
} else {
Display::display_error_message(get_lang('BrowserDontSupportsSVG'));
}
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/document/edit_paint.php b/main/document/edit_paint.php
index dd0f155cfc..334cf58ca8 100644
--- a/main/document/edit_paint.php
+++ b/main/document/edit_paint.php
@@ -1,6 +1,5 @@
';
echo '';
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/document/exit_pixlr.php b/main/document/exit_pixlr.php
index 572e0b1722..e6a46b0b90 100644
--- a/main/document/exit_pixlr.php
+++ b/main/document/exit_pixlr.php
@@ -9,6 +9,9 @@
* @author Juan Carlos Ra�a Trabado
* @since 30/january/2011
*/
+/**
+ * Code
+ */
require_once '../inc/global.inc.php';
api_protect_course_script();
@@ -33,4 +36,4 @@ else{
$location=api_get_path(WEB_CODE_PATH).'document/document.php?id='.Security::remove_XSS($_SESSION['exit_pixlr']);
echo '';
unset($_SESSION['exit_pixlr']);
-}
\ No newline at end of file
+}
diff --git a/main/document/footerpage.php b/main/document/footerpage.php
index 5ea43ab0e2..deeba24cf9 100755
--- a/main/document/footerpage.php
+++ b/main/document/footerpage.php
@@ -1,11 +1,12 @@
";
echo ''.get_lang('_cut_paste_link').'';
-echo "";
\ No newline at end of file
+echo "";
diff --git a/main/document/quota.php b/main/document/quota.php
index 0747f6c821..b1d8dc72e7 100755
--- a/main/document/quota.php
+++ b/main/document/quota.php
@@ -9,6 +9,9 @@
* @author Roan Embrechts
* @package chamilo.document
*/
+/**
+ * Code
+ */
// Name of the language file that needs to be included
exit;
diff --git a/main/document/record_audio.php b/main/document/record_audio.php
index 0c0a429d3b..a0bc544bef 100644
--- a/main/document/record_audio.php
+++ b/main/document/record_audio.php
@@ -9,6 +9,9 @@
* @author Juan Carlos Raña Trabado herodoto@telefonica.net
* @since 5/mar/2011
*/
+/**
+ * Code
+ */
/* INIT SECTION */
@@ -210,4 +213,4 @@ if ($array_browser[0]=="Internet Explorer") {
echo '';
}
echo '';
-Display :: display_footer();
\ No newline at end of file
+Display :: display_footer();
diff --git a/main/document/save_pixlr.php b/main/document/save_pixlr.php
index 4957c0c9bb..3425dfee10 100644
--- a/main/document/save_pixlr.php
+++ b/main/document/save_pixlr.php
@@ -1,6 +1,5 @@
window.parent.location.href="'.$location.'"';
unset($_SESSION['exit_pixlr']);
-}
\ No newline at end of file
+}
diff --git a/main/document/showinframes.php b/main/document/showinframes.php
index e7263376ad..d3fe6a213d 100755
--- a/main/document/showinframes.php
+++ b/main/document/showinframes.php
@@ -1,6 +1,5 @@
';
}
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/document/showinframesmin.php b/main/document/showinframesmin.php
index 2cfd37722d..4ba03d1361 100644
--- a/main/document/showinframesmin.php
+++ b/main/document/showinframesmin.php
@@ -1,12 +1,13 @@
';
-}
\ No newline at end of file
+}
diff --git a/main/document/slideshow.php b/main/document/slideshow.php
index 702b658221..eaf7d7a73a 100755
--- a/main/document/slideshow.php
+++ b/main/document/slideshow.php
@@ -1,13 +1,14 @@
';
echo '';
echo '';
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/messages/index.php b/main/messages/index.php
old mode 100644
new mode 100755
index 5464eaf1fb..8a32e2a469
--- a/main/messages/index.php
+++ b/main/messages/index.php
@@ -3,7 +3,9 @@
/**
* @package chamilo.messages
*/
-
+/**
+ * Code
+ */
require_once '../inc/global.inc.php';
if (api_get_setting('allow_social_tool')=='true' && api_get_setting('allow_message_tool')=='true') {
header('Location:inbox.php?f=social');
@@ -11,4 +13,4 @@ if (api_get_setting('allow_social_tool')=='true' && api_get_setting('allow_mess
header('Location:inbox.php');
}
exit;
-?>
\ No newline at end of file
+?>
diff --git a/main/messages/outbox.php b/main/messages/outbox.php
index 0e3ff21790..553588e165 100755
--- a/main/messages/outbox.php
+++ b/main/messages/outbox.php
@@ -3,7 +3,9 @@
/**
* @package chamilo.messages
*/
-
+/**
+ * Code
+ */
// name of the language file that needs to be included
$language_file = array('registration','messages','userInfo');
$cidReset=true;
@@ -179,4 +181,4 @@ echo '
';
echo '
';
/* FOOTER */
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/messages/send_message.php b/main/messages/send_message.php
old mode 100644
new mode 100755
index 7242f004e0..48c2404752
--- a/main/messages/send_message.php
+++ b/main/messages/send_message.php
@@ -3,7 +3,9 @@
/**
* @package chamilo.messages
*/
-
+/**
+ * Code
+ */
$language_file = array('registration','messages','userInfo','admin');
$cidReset=true;
require_once '../inc/global.inc.php';
@@ -78,4 +80,4 @@ if ($panel_id==4 && !empty($content_message)) {
} elseif ($panel_id==5 && !empty($subject_message) ) {
SocialManager::send_invitation_friend_user($user_id,$subject_message,$content_message);
}
-?>
\ No newline at end of file
+?>
diff --git a/main/messages/send_message_to_userfriend.inc.php b/main/messages/send_message_to_userfriend.inc.php
index 432e823ee6..7adfc5cf09 100755
--- a/main/messages/send_message_to_userfriend.inc.php
+++ b/main/messages/send_message_to_userfriend.inc.php
@@ -3,6 +3,9 @@
/**
* @package chamilo.messages
*/
+/**
+ * Code
+ */
$language_file = array('registration','messages','userInfo','admin');
$cidReset = true;
require_once '../inc/global.inc.php';
@@ -57,4 +60,4 @@ if (api_get_setting('allow_message_tool')=='true') {
-
\ No newline at end of file
+
diff --git a/main/messages/view_message.php b/main/messages/view_message.php
index 59099fd891..a3d2a9abf6 100755
--- a/main/messages/view_message.php
+++ b/main/messages/view_message.php
@@ -3,7 +3,9 @@
/**
* @package chamilo.messages
*/
-
+/**
+ * Code
+ */
$language_file = array('registration','messages','userInfo');
$cidReset= true;
require_once '../inc/global.inc.php';
@@ -85,4 +87,4 @@ echo '
';
echo '
';
/* FOOTER */
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();
diff --git a/main/user/subscribe_user.php b/main/user/subscribe_user.php
index 30d25b99c8..847debf1b7 100755
--- a/main/user/subscribe_user.php
+++ b/main/user/subscribe_user.php
@@ -6,6 +6,9 @@
* to their course.
* @package chamilo.user
*/
+/**
+ * Code
+ */
/* INIT SECTION */
// name of the language file that needs to be included
@@ -771,4 +774,4 @@ function display_extra_profile_fields_filter()
echo '';
echo '';
echo '';
-}
\ No newline at end of file
+}
diff --git a/main/user/user_add.php b/main/user/user_add.php
index 1ea57522d0..b5803ecd41 100755
--- a/main/user/user_add.php
+++ b/main/user/user_add.php
@@ -3,6 +3,9 @@
/**
* @package chamilo.user
*/
+/**
+ * Code
+ */
/* INIT */
@@ -366,4 +369,4 @@ else
echo "
".get_lang('IfYouWantToAddManyUsers')."
";
}
-Display::display_footer();
\ No newline at end of file
+Display::display_footer();