Skip to content

Commit

Permalink
update file docblocks & remove unneeded files
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Weibel committed Jun 2, 2011
1 parent 96074bd commit 0e4c82f
Show file tree
Hide file tree
Showing 53 changed files with 811 additions and 324 deletions.
23 changes: 19 additions & 4 deletions Application/ErrorController.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
<?php
/**
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Manuel Alabor <malabor@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Html5Wiki
* @subpackage Application
*/

/**
* Error Controller<br/>
* Used by set_exception_handler & set_error_handler<br/>
*
* This class recreates a lot of the encapsulated logic of abstract controller
* and Html5Wiki_Routing_Router.<br/>
* A definitive candidate for refactoring ;)
*
* @author Manuel Alabor <malabor@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Application
*/
class Application_ErrorController {

Expand Down
19 changes: 17 additions & 2 deletions Application/IndexController.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
<?php
/**
* Index Controller for the overall history page
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Application
* @package Html5Wiki
* @subpackage Application
*/

/**
* Index Controller for the overall history page & the search page.
*/
class Application_IndexController extends Html5Wiki_Controller_Abstract {

Expand Down
13 changes: 11 additions & 2 deletions Application/WikiController.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
<?php

/**
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright Html5Wiki 2011
* @copyright (c) HTML5Wiki Team 2011
* @package Html5Wiki
* @subpackage Application
*/
Expand Down
22 changes: 22 additions & 0 deletions build/build.xml
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
<!--
This file is part of the HTML5Wiki Project.
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to mweibel@hsr.ch so we can send you a copy immediately.
@author Michael Weibel <mweibel@hsr.ch>
@copyright (c) HTML5Wiki Team 2011
@package Html5Wiki
@subpackage Build
-->

<!--
Cruisecontrol build file
-->
<project basedir="../../" default="build" name="html5wiki">
<target name="checkout">
<exec dir="${basedir}/source" executable="git">
Expand Down
22 changes: 22 additions & 0 deletions build/config.xml
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
<!--
This file is part of the HTML5Wiki Project.
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to mweibel@hsr.ch so we can send you a copy immediately.
@author Michael Weibel <mweibel@hsr.ch>
@copyright (c) HTML5Wiki Team 2011
@package Html5Wiki
@subpackage Build
-->

<!--
Cruisecontrol config file
-->
<cruisecontrol>
<project buildafterfailed="true" name="html5wiki">
<plugin classname="net.sourceforge.cruisecontrol.sourcecontrols.Git" name="git"></plugin>
Expand Down
14 changes: 12 additions & 2 deletions build/updateToLatestBuild.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
#!/bin/sh
#
# This file is part of the html5wiki package
# 
# This file is part of the HTML5Wiki Project.
#
# LICENSE
#
# This source file is subject to the new BSD license that is bundled
# with this package in the file LICENSE.txt.
# It is also available through the world-wide-web at this URL:
# http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
# If you did not receive a copy of the license and are unable to
# obtain it through the world-wide-web, please send an email
# to mweibel@hsr.ch so we can send you a copy immediately.
#
# Update public webserver
#
# @copyright 2011 HTML5Wiki Team
Expand Down
15 changes: 13 additions & 2 deletions config/config.php.sample
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
<?php
/**
* Sample configuration
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Config
* @package Html5Wiki
* @subpackage Application
*/

$config = array(
Expand Down
21 changes: 18 additions & 3 deletions dist/build.xml
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
<!--
This file is part of the HTML5Wiki Project.
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to mweibel@hsr.ch so we can send you a copy immediately.
@author Manuel Alabor <malabor@hsr.ch>
@copyright (c) HTML5Wiki Team 2011
@package Html5Wiki
@subpackage Build
-->
<!--
/**
* build.xml - Distribution ANT Build Script<br/>
* Creates a distributable version of HTML5Wiki.</br>
* It uses Googles Closure Compiler to minify and optimize all our javascripts.<br/>
* <br/>
* Main-target is "zip"
*
* @copyright (C) Copyright by HTML5Wiki Team
* @author Manuel Alabor <malabor@hsr.ch>
*/
-->
<project name="HTML5Wiki" default="zip" basedir=".">
Expand Down
21 changes: 21 additions & 0 deletions languages/de.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
<?php
/**
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Html5Wiki
* @subpackage Language
*/

/**
* German language file
*/
return array(
'timestampFormat' => 'd.m.Y H:i'
,'timeFormat' => 'H:i'
Expand Down
21 changes: 21 additions & 0 deletions languages/en.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
<?php
/**
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @package Html5Wiki
* @subpackage Application
*/

/**
* English language file
*/
return array(
'timestampFormat' => 'Y-m-d H:i'
,'timeFormat' => 'H:i'
Expand Down
17 changes: 14 additions & 3 deletions library/Html5Wiki/Controller/Abstract.php
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
<?php
/**
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright Html5Wiki 2011
* @package Html5Wiki
* @subpackage Library
* @copyright (c) HTML5Wiki Team 2011
* @category Html5Wiki
* @package Library
* @subpackage Controller
*/

/**
Expand Down
17 changes: 16 additions & 1 deletion library/Html5Wiki/Controller/Factory.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
<?php
/**
* Controller factory creates a new controller according to the informations from the router.
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @category Html5Wiki
* @package Library
* @subpackage Controller
*/

/**
* Controller factory creates a new controller according to the informations from the router.
*/
class Html5Wiki_Controller_Factory {

const APPLICATION_NAMESPACE = 'Application_';
Expand Down
17 changes: 16 additions & 1 deletion library/Html5Wiki/Controller/Front.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
<?php
/**
* The FrontController sets the whole system up and dispatches the request
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @category Html5Wiki
* @package Library
* @subpackage Controller
*/

/**
* The FrontController sets the whole system up and dispatches the request
*/
class Html5Wiki_Controller_Front {

/**
Expand Down
18 changes: 17 additions & 1 deletion library/Html5Wiki/Exception.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
<?php
/**
* Basic exception class
* This file is part of the HTML5Wiki Project.
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.github.com/HTML5Wiki/HTML5Wiki/blob/master/LICENSE
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to mweibel@hsr.ch so we can send you a copy immediately.
*
* @author Michael Weibel <mweibel@hsr.ch>
* @copyright (c) HTML5Wiki Team 2011
* @category Html5Wiki
* @package Library
* @subpackage Exception
*/

/**
* Basic HTML5Wiki Exception
*/
class Html5Wiki_Exception extends Exception {
//put your code here
Expand Down
Loading

0 comments on commit 0e4c82f

Please sign in to comment.