Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Change some order in page-level docblock comments to fix errors given by phpDocumentor #1594

Closed
wants to merge 5 commits into from

3 participants

@casvannoort

phpDocumentor demands that there is no php code before the first page-level block. This fixes the errors for the committed files. If this pull is accepted, I will continue changing this for the other files.

@alexbilbie

I appreciate that your pull request is a valid change, my only question is why you are building documentation for CI with phpDocumentor? We've already got pretty good documentation

@casvannoort

Personally I think automatic parsing and validation of potentially releases is a powerful tool. Besides that I noticed that there was a similar issue:
#1295

@narfbg narfbg referenced this pull request from a commit
@narfbg narfbg Manually apply PR #1594 (fixing phpdoc page-level generation/warnings)
Also partially fixes issue #1295, fixes inconsistencies in some page-level docblocks and adds include checks in language files.
c5536aa
@narfbg
Owner

See the above commit.

@narfbg narfbg closed this
@nonchip nonchip referenced this pull request from a commit in nonchip/CodeIgniter
@narfbg narfbg Manually apply PR #1594 (fixing phpdoc page-level generation/warnings)
Also partially fixes issue #1295, fixes inconsistencies in some page-level docblocks and adds include checks in language files.
b6888cb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 84 additions and 36 deletions.
  1. +2 −1  application/config/autoload.php
  2. +2 −1  application/config/config.php
  3. +2 −1  application/config/constants.php
  4. +3 −1 application/config/database.php
  5. +2 −1  application/config/doctypes.php
  6. +2 −1  application/config/foreign_chars.php
  7. +2 −1  application/config/hooks.php
  8. +2 −1  application/config/memcached.php
  9. +2 −1  application/config/migration.php
  10. +2 −1  application/config/mimes.php
  11. +2 −1  application/config/profiler.php
  12. +2 −1  application/config/routes.php
  13. +2 −1  application/config/smileys.php
  14. +2 −1  application/config/user_agents.php
  15. +10 −1 application/controllers/welcome.php
  16. +2 −1  application/views/errors/error_404.php
  17. +2 −1  application/views/errors/error_db.php
  18. +2 −1  application/views/errors/error_general.php
  19. +2 −1  application/views/errors/error_php.php
  20. +4 −1 application/views/welcome_message.php
  21. +2 −1  system/core/Benchmark.php
  22. +2 −1  system/core/CodeIgniter.php
  23. +2 −1  system/core/Common.php
  24. +2 −1  system/core/Config.php
  25. +2 −1  system/core/Controller.php
  26. +2 −1  system/core/Exceptions.php
  27. +2 −1  system/core/Hooks.php
  28. +2 −1  system/core/Input.php
  29. +2 −1  system/core/Lang.php
  30. +2 −1  system/core/Loader.php
  31. +2 −1  system/core/Model.php
  32. +3 −1 system/core/Output.php
  33. +2 −1  system/core/Router.php
  34. +2 −1  system/core/Security.php
  35. +2 −1  system/core/URI.php
  36. +2 −1  system/core/Utf8.php
View
3  application/config/autoload.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------
View
3  application/config/config.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
|--------------------------------------------------------------------------
View
3  application/config/constants.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
|--------------------------------------------------------------------------
View
4 application/config/database.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,8 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+
/*
| -------------------------------------------------------------------
| DATABASE CONNECTIVITY SETTINGS
View
3  application/config/doctypes.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
$_doctypes = array(
'xhtml11' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">',
View
3  application/config/foreign_chars.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------
View
3  application/config/hooks.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------------
View
3  application/config/memcached.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 2.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------------
View
3  application/config/migration.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
|--------------------------------------------------------------------------
View
3  application/config/mimes.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------
View
3  application/config/profiler.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------------
View
3  application/config/routes.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------------
View
3  application/config/smileys.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------
View
3  application/config/user_agents.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
| -------------------------------------------------------------------
View
11 application/controllers/welcome.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,7 +24,16 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * CodeIgniter Application Welcome Controller
+ *
+ * This class enables the welcome screen for new installations.
+ *
+ * @package CodeIgniter
+ * @author EllisLab Dev Team
+ */
class Welcome extends CI_Controller {
/**
View
3  application/views/errors/error_404.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
?><!DOCTYPE html>
<html lang="en">
<head>
View
3  application/views/errors/error_db.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
?><!DOCTYPE html>
<html lang="en">
<head>
View
3  application/views/errors/error_general.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
?><!DOCTYPE html>
<html lang="en">
<head>
View
3  application/views/errors/error_php.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
?>
<div style="border:1px solid #990000;padding-left:20px;margin:0 0 10px 0;">
View
5 application/views/welcome_message.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,9 @@
* @since Version 1.0
* @filesource
*/
+
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+
?><!DOCTYPE html>
<html lang="en">
<head>
View
3  system/core/Benchmark.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter Benchmark Class
View
3  system/core/CodeIgniter.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* System Initialization File
View
3  system/core/Common.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Common Functions
View
3  system/core/Config.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter Config Class
View
3  system/core/Controller.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter Application Controller Class
View
3  system/core/Exceptions.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Exceptions Class
View
3  system/core/Hooks.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter Hooks Class
View
3  system/core/Input.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Input Class
View
3  system/core/Lang.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Language Class
View
3  system/core/Loader.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Loader Class
View
3  system/core/Model.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter Model Class
View
4 system/core/Output.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Output Class
@@ -205,6 +206,7 @@ public function set_header($header, $replace = TRUE)
* Set Content Type Header
*
* @param string extension of the file we're outputting
+ * @param string
* @return void
*/
public function set_content_type($mime_type, $charset = NULL)
View
3  system/core/Router.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Router Class
View
3  system/core/Security.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Security Class
View
3  system/core/URI.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 1.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* URI Class
View
3  system/core/Utf8.php
@@ -1,4 +1,4 @@
-<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+<?php
/**
* CodeIgniter
*
@@ -24,6 +24,7 @@
* @since Version 2.0
* @filesource
*/
+if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Utf8 Class
Something went wrong with that request. Please try again.