chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Minor - Adapting code comments to phpdoc

Browse Source
skala
Yannick Warnier 14 years ago
parent e09f6019a0
commit b80cabb1a5
24 changed files with 91 additions and 90 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 19
      main/blog/blog.php
  2. 12
      main/blog/blog_admin.php
  3. 9
      main/blog/calendar.php
  4. 7
      main/blog/download.php
  5. 2
      main/metadata/doc/mdApiTest.php
  6. 4
      main/metadata/doc/testMiniDom.php
  7. 4
      main/metadata/doc/testXht.php
  8. 2
      main/metadata/importlinks.php
  9. 2
      main/metadata/importmanifest.php
  10. 2
      main/metadata/index.php
  11. 27
      main/metadata/md_document.php
  12. 4
      main/metadata/md_funcs.php
  13. 26
      main/metadata/md_mix.php
  14. 2
      main/metadata/md_phpdig.php
  15. 24
      main/metadata/md_scorm.php
  16. 2
      main/metadata/openobject.php
  17. 2
      main/metadata/phpdig/search.php
  18. 2
      main/metadata/playscormmdset.inc.php
  19. 2
      main/metadata/search.php
  20. 2
      main/metadata/statistics.php
  21. 4
      main/metadata/update_indexabletext.php
  22. 10
      main/resourcelinker/resourcelinker.php
  23. 7
      main/search/index.php
  24. 4
      main/search/search_suggestions.php

19
main/blog/blog.php
Unescape View File

@ -1,16 +1,13 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
BLOG HOMEPAGE * BLOG HOMEPAGE
* This file takes care of all blog navigation and displaying.
This file takes care of all blog navigation and displaying. * @package chamilo.blogs
@package chamilo.blogs */
*/ /**
* INIT
/* */
INIT
*/
// name of the language file that needs to be included // name of the language file that needs to be included
$language_file = "blog"; $language_file = "blog";
$blog_id = intval($_GET['blog_id']); $blog_id = intval($_GET['blog_id']);
@ -519,4 +516,4 @@ switch ($current_page)
<?php <?php
// Display the footer // Display the footer
Display::display_footer(); Display::display_footer();
?> ?>

12
main/blog/blog_admin.php
Unescape View File

@ -1,11 +1,13 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
BLOG HOMEPAGE * BLOG HOMEPAGE
This file takes care of all blog navigation and displaying. * This file takes care of all blog navigation and displaying.
@package chamilo.blogs * @package chamilo.blogs
*/ */
/**
* Code
*/
// name of the language file that needs to be included // name of the language file that needs to be included
$language_file = 'blog'; $language_file = 'blog';
@ -125,4 +127,4 @@ if (api_is_allowed_to_edit()) {
// Display the footer // Display the footer
Display::display_footer(); Display::display_footer();
?> ?>

9
main/blog/calendar.php
Unescape View File

@ -1,5 +1,12 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/**
* Blog calendar
* @package chamilo.blogs
*/
/**
* Code
*/
// name of the language file that needs to be included // name of the language file that needs to be included
$language_file = 'agenda'; $language_file = 'agenda';
@ -128,4 +135,4 @@ foreach($DaysShort as $index => $day)
<div id="calendar_data"></div> <div id="calendar_data"></div>
<div id="clock_data"></div> <div id="clock_data"></div>
</body> </body>
</html> </html>

7
main/blog/download.php
Unescape View File

@ -9,8 +9,9 @@
* @package chamilo.blogs * @package chamilo.blogs
*/ */
/* MAIN CODE */ /**
* MAIN CODE
*/
session_cache_limiter('public'); session_cache_limiter('public');
require_once '../inc/global.inc.php'; require_once '../inc/global.inc.php';
@ -61,4 +62,4 @@ if (Database::num_rows($result) > 0) {
DocumentManager::file_send_for_download($full_file_name, TRUE, $row['filename']); DocumentManager::file_send_for_download($full_file_name, TRUE, $row['filename']);
} }
} }
exit; exit;

2
main/metadata/doc/mdApiTest.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* mdApiTest.php * mdApiTest.php
* @date 2004/09/30 * 2004/09/30
* @copyright 2004 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2004 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

4
main/metadata/doc/testMiniDom.php
Unescape View File

@ -1,8 +1,8 @@
<?php <?php
/** /**
* testMiniDom.php * testMiniDom.php
* @date 2005/03/16 * 2005/03/16
* @date for XML MiniDom, 2005/03/16 * for XML MiniDom, 2005/03/16
* @copyright (C) 2005 rene.haentjens@UGent.be * @copyright (C) 2005 rene.haentjens@UGent.be
* @package chamilo.metadata * @package chamilo.metadata
*/ */

4
main/metadata/doc/testXht.php
Unescape View File

@ -1,8 +1,8 @@
<?php <?php
/** /**
* testXht.php, * testXht.php,
* @date 2005/03/16 * 2005/03/16
* @date for XML HTML Templates, 2005/03/16 * for XML HTML Templates, 2005/03/16
* @copyright 2005 rene.haentjens@UGent.be --> * @copyright 2005 rene.haentjens@UGent.be -->
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/importlinks.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/importlinks.php * Chamilo metadata/importlinks.php
* @date 2006/12/15 * 2006/12/15
* Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php * Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/importmanifest.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/importmanifest.php * Chamilo metadata/importmanifest.php
* @date 2006/12/15 * 2006/12/15
* Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php * Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/index.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/index.php * Chamilo metadata/index.php
* @date 2005/05/19 * 2005/05/19
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

27
main/metadata/md_document.php
Unescape View File

@ -1,20 +1,15 @@
<?php /* <!-- md_document.php for Dokeos metadata/*.php --> <?php
<!-- 2005/09/20 -->
<!-- Copyright (C) 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php -->
*/
/** /**
============================================================================== * md_document.php for Dokeos metadata/*.php
* Dokeos Metadata: class mdobject for Document-type items * 2005/09/20
* * Copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php -->
* @package dokeos.metadata * @package chamilo.metadata
============================================================================== */
*/ /**
* Chamilo Metadata: class mdobject for Document-type items
class mdobject */
{
class mdobject {
var $mdo_course; var $mdo_course;
var $mdo_type; var $mdo_type;

4
main/metadata/md_funcs.php
Unescape View File

@ -248,7 +248,9 @@ EOD
// METADATA STORE -------------------------------------------------------------> // METADATA STORE ------------------------------------------------------------->
/**
* mdstore class
*/
class mdstore class mdstore
{ {

26
main/metadata/md_mix.php
Unescape View File

@ -1,20 +1,14 @@
<?php /* <!-- md_mix.php for Dokeos metadata/*.php --> <?php
<!-- 2005/09/20 -->
<!-- Copyright (C) 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php -->
*/
/** /**
============================================================================== * md_mix.php for Dokeos metadata/*.php
* Dokeos Metadata: reduced class mdobject for Search, for a Mix of objects * 2005/09/20
* * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package dokeos.metadata * @package chamilo.metadata
============================================================================== */
*/ /**
* Chamilo Metadata: reduced class mdobject for Search, for a Mix of objects
class mdobject */
{ class mdobject {
var $mdo_course; var $mdo_course;
var $mdo_type; var $mdo_type;

2
main/metadata/md_phpdig.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/md_phpdig.php * Chamilo metadata/md_phpdig.php
* @date 2005/03/24 * 2005/03/24
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
* *

24
main/metadata/md_scorm.php
Unescape View File

@ -1,17 +1,13 @@
<?php /* <!-- md_scorm.php for Dokeos metadata/*.php --> <?php
<!-- 2006/12/15 --> /**
* md_scorm.php for Chamilo metadata/*.php
<!-- Copyright (C) 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php --> * 2006/12/15
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
*/ * @package chamilo.metadata
*/
/** /**
============================================================================== * Chamilo Metadata: class mdobject for Scorm-type objects
* Dokeos Metadata: class mdobject for Scorm-type objects */
*
* @package dokeos.metadata
==============================================================================
*/
class mdobject class mdobject
{ {
@ -107,4 +103,4 @@ function mdobject($_course, $id)
} }
} }
?> ?>

2
main/metadata/openobject.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/openobject.php * Chamilo metadata/openobject.php
* @date 2004/08/27 * 2004/08/27
* Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php * Copyright (C) 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/phpdig/search.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo phpdig/search.php * Chamilo phpdig/search.php
* @date 2006/12/14 * 2006/12/14
* @copyright 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2006 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/playscormmdset.inc.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/playscormmdset.inc.php * Chamilo metadata/playscormmdset.inc.php
* @date 2005/11/16 * 2005/11/16
* Copyright (C) 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * Copyright (C) 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

2
main/metadata/search.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/search.php * Chamilo metadata/search.php
* @date 2005/09/20 * 2005/09/20
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package dokeos.metadata * @package dokeos.metadata
*/ */

2
main/metadata/statistics.php
Unescape View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Chamilo metadata/statistics.php * Chamilo metadata/statistics.php
* @date 2005/02/02 * 2005/02/02
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata * @package chamilo.metadata
*/ */

4
main/metadata/update_indexabletext.php
Unescape View File

@ -1,12 +1,12 @@
<?php <?php
/** /**
* Chamilo metadata/udate_indexableText.php * Chamilo metadata/udate_indexableText.php
* @date 2005/03/16 * 2005/03/16
* @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php * @copyright 2005 rene.haentjens@UGent.be - see metadata/md_funcs.php
* @package chamilo.metadata
*/ */
/** /**
* Chamilo Metadata: update indexabletext for all eid_type records * Chamilo Metadata: update indexabletext for all eid_type records
* @package chamilo.metadata
*/ */
// PRELIMS --------------------------------------------------------------------> // PRELIMS -------------------------------------------------------------------->

10
main/resourcelinker/resourcelinker.php
Unescape View File

@ -4,15 +4,15 @@
* @author Patrick Cool, original code * @author Patrick Cool, original code
* @author Denes Nagy - many bugfixes and improvements, adjusted for learning path * @author Denes Nagy - many bugfixes and improvements, adjusted for learning path
* @author Roan Embrechts - refactoring, code cleaning * @author Roan Embrechts - refactoring, code cleaning
* @package dokeos.resourcelinker * @package chamilo.resourcelinker
* @todo reorganise code - This class is used? * @todo reorganise code - This class is used?
* use Database API instead of creating table names locally. * use Database API instead of creating table names locally.
* *
*/ */
/* /**
INIT SECTION * INIT SECTION
*/ */
// name of the language file that needs to be included // name of the language file that needs to be included
//$language_file = 'resourcelinker';// TODO: Repeated deleting and moving the rest of this lang file to trad4all //$language_file = 'resourcelinker';// TODO: Repeated deleting and moving the rest of this lang file to trad4all
include ('../inc/global.inc.php'); include ('../inc/global.inc.php');
@ -1015,4 +1015,4 @@ echo "</td></tr></table>";
FOOTER FOOTER
*/ */
Display :: display_footer(); Display :: display_footer();
?> ?>

7
main/search/index.php
Unescape View File

@ -1,9 +1,12 @@
<?php <?php
/* For licensing terms, see /license.txt */ /* For licensing terms, see /license.txt */
/** /**
* This file includes lp_list_search to avoid duplication of code, it * This file includes lp_list_search to avoid duplication of code, it
* bootstraps chamilo api enough to make lp_list_search work. * bootstraps chamilo api enough to make lp_list_search work.
* @package chamilo.search
*/
/**
* Code
*/ */
$language_file = array('admin'); $language_file = array('admin');
require_once '../inc/global.inc.php'; require_once '../inc/global.inc.php';
@ -21,4 +24,4 @@ if (extension_loaded('xapian')) {
Display::display_error_message(get_lang('SearchXapianModuleNotInstalled')); Display::display_error_message(get_lang('SearchXapianModuleNotInstalled'));
Display::display_footer(); Display::display_footer();
exit; exit;
} }

4
main/search/search_suggestions.php
Unescape View File

@ -1,6 +1,10 @@
<?php <?php
/* /*
* Suggest words to search * Suggest words to search
* @package chamilo.search
*/
/**
* Code
*/ */
require_once dirname(__FILE__) . '/../inc/global.inc.php'; require_once dirname(__FILE__) . '/../inc/global.inc.php';

Write Preview
Loading…
Cancel
Save