edit: doc stuff

trunk/includes/help/start.php

@@ -1,7 +1,42 @@
 <?php
-//echo "OK";
+/**
-
+ * File: start.php
-function my_admin_notice(){
+ * 
+ * Startfile for help system, uses contextual help tab in admin area
+ * @todo write help tpl-files for default and german translation
+ * 
+ * @package     SemmelstatzR
+ * @version     $Rev$
+ * @since       1.0.0 Beta
+ * @author      SEM-Team
+ * @copyright   (c)2011 SEM-Team
+ * @link        http://sourceforge.net/projects/semmelstatz/
+ * @license     http://www.gnu.org/licenses/gpl-3.0.html
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.  
+ *
+ * $Id$
+ * 
+ */
+/**
+ * gives a hint for admins in admin area
+ * 
+ * @author  Ortwin Pinke
+ * @since   1.0.1 Beta
+ * @uses    wp add_filter()
+ */
+function semr_admin_notice(){
     if(strstr(SEMMELSTATZR_VERSION, "Beta") !== false) {
         echo '<div class="updated">
             <p>You are using a beta-version of semmelstatzReloaded. 
@@ -9,9 +44,10 @@ function my_admin_notice(){
             </div>'; 
     }
 }
-add_filter('admin_notices', 'my_admin_notice');
+add_filter('admin_notices', 'semr_admin_notice');
 
 /*
+// just for debugging on local machines
 function check_current_screen() {
     echo '<div class="updated"><pre>';
     if( !is_admin() ) return;
@@ -21,6 +57,21 @@ function check_current_screen() {
 }
 add_filter('admin_notices', 'check_current_screen');
 */
+
+/**
+ * bind the help files with contextual help area of wp
+ * 
+ * @author  Ortwin Pinke
+ * @since   1.0.1 Beta
+ * @uses    wp add_filter()
+ * 
+ * @global array $semr_hook
+ * @global string $wp_version
+ * @param string $contextual_help
+ * @param string $screen_id
+ * @param array $screen
+ * @return string 
+ */
 function semmelstatzR_help($contextual_help, $screen_id, $screen) {
     global $semr_hook, $wp_version;
     $semrContextHelp = '';