[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] phpgroupware/doc cvs_full_checkout.php, 1.14 inlinedo
|
From: |
powerstat |
|
Subject: |
[Phpgroupware-cvs] phpgroupware/doc cvs_full_checkout.php, 1.14 inlinedocparser.php, 1.31 |
|
Date: |
Fri, 15 Apr 2005 15:19:00 +0200 |
Update of phpgroupware/doc
Modified Files:
Branch: MAIN
cvs_full_checkout.php lines: +52 -28
inlinedocparser.php lines: +63 -54
Log Message:
Converted to phpdoc.
Verified with phpdocumentor and php -l
Also cleaned up some HTML code and unified include_once('header.inc.php')
====================================================
Index: phpgroupware/doc/cvs_full_checkout.php
diff -u phpgroupware/doc/cvs_full_checkout.php:1.13
phpgroupware/doc/cvs_full_checkout.php:1.14
--- phpgroupware/doc/cvs_full_checkout.php:1.13 Thu Dec 30 10:46:22 2004
+++ phpgroupware/doc/cvs_full_checkout.php Fri Apr 15 13:19:15 2005
@@ -1,36 +1,49 @@
#!/usr/bin/php
<?php
- exit;//remove this line to make the script work
-
/**************************************************************************\
- * phpGroupWare
*
- * http://www.phpgroupware.org/
*
- * The file written by Dan Kuykendall <address@hidden> *
- * Joseph Engo <address@hidden> *
- * --------------------------------------------
*
- * 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 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
-
- /* $Id$ */
-
-
/****************************************************************************\
- * Config section
*
-
\****************************************************************************/
- // Temp paths that can be read and written to
- $tmp_dir = '/tmp';
- // Directory that you want the phpgroupware directory to go in. NO
trailing /
- $co_dir = '/var/www/html';
- // If you do not have developer access to cvs, set to True
+ /**
+ * phpGroupWare
+ *
+ * phpgroupware base
+ * @author Dan Kuykendall <address@hidden>
+ * @author Joseph Engo <address@hidden>
+ * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc.
http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package phpgroupware
+ * @subpackage development
+ * @version $Id$
+ */
+
+ exit; //remove this line to make the script work
+
+ //
****************************************************************************
+ // Config section
+ //
****************************************************************************
+
+ /**
+ * Temp paths that can be read and written to
+ */
+ $tmp_dir = '/tmp';
+ /**
+ * Directory that you want the phpgroupware directory to go in. NO
trailing /
+ */
+ $co_dir = '/var/www/html';
+ /**
+ * If you do not have developer access to cvs, set to True
+ */
$cvs_anonymous = True;
- // If you do not have developer access to phpgwapi cvs, set to True
+ /**
+ * If you do not have developer access to phpgwapi cvs, set to True
+ */
$cvs_api_anonymous = True;
- // Only needed if you have developers cvs access
- $cvs_login = '';
+ /**
+ * Only needed if you have developers cvs access
+ */
+ $cvs_login = '';
- // Modules you want to checkout, do NOT add the phpgroupware module
+ /**
+ * Modules you want to checkout, do NOT add the phpgroupware module
+ */
$co_modules[] = 'addressbook';
$co_modules[] = 'admin';
$co_modules[] = 'backup';
@@ -90,8 +103,18 @@
$co_modules[] = 'weather';
$co_modules[] = 'xmlrpc';
- // -- End config section
+ //
****************************************************************************
+ // End config section
+ //
****************************************************************************
+
+ /**
+ * Do cvs command
+ *
+ * This will do the cvs command
+ * @param string $command
+ * @param boolean $anonymous_login
+ */
function docvscommand($command, $anonymous_login = False)
{
global $tmp_dir, $cvs_anonymous;
@@ -124,6 +147,7 @@
unlink($tmp_dir . '/createrelease.exp');
}
+
chdir($co_dir);
if ($cvs_anonymous)
{
====================================================
Index: phpgroupware/doc/inlinedocparser.php
diff -u phpgroupware/doc/inlinedocparser.php:1.30
phpgroupware/doc/inlinedocparser.php:1.31
--- phpgroupware/doc/inlinedocparser.php:1.30 Thu Dec 30 10:46:22 2004
+++ phpgroupware/doc/inlinedocparser.php Fri Apr 15 13:19:15 2005
@@ -1,32 +1,41 @@
<?php
-
/**************************************************************************\
- * phpGroupWare
*
- * http://www.phpgroupware.org
*
- * The file written by Miles Lott <address@hidden> *
- * --------------------------------------------
*
- * 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 2 of the License, or (at
your *
- * option) any later version.
*
-
\**************************************************************************/
-
- /* $Id$ */
-
-
/**************************************************************************\
- * These are the few functions needed for parsing the inline comments
*
-
\**************************************************************************/
+ /**
+ * phpGroupWare
+ *
+ * phpgroupware old inline doc parser (pre phpdoc)
+ * @author Miles Lott <address@hidden>
+ * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc.
http://www.fsf.org/
+ * @license http://www.gnu.org/licenses/gpl.html GNU General Public
License
+ * @package phpgroupware
+ * @subpackage documentation
+ * @version $Id$
+ */
+
+
+ //
*************************************************************************
+ // These are the few functions needed for parsing the inline comments
+ //
*************************************************************************
+
$phpgw_info['flags']['noapi'] = True;
+
+ /**
+ * Include phpgroupware header
+ */
include ('../header.inc.php');
+
if (floor(phpversion()) == 3)
{
+ /**
+ * Include PHP3 support functions
+ */
include (PHPGW_API_INC.'/php3_support_functions.inc.php');
}
- /*!
- @function array_print
- @abstract output an array for HTML.
- @syntax array_print($array);
- @example array_print($my_array);
+
+ /**
+ * Function to print an array to HTML
+ *
+ * @param array $array Array to output as HTML
*/
function array_print($array)
{
@@ -44,12 +53,12 @@
}
}
- /*!
- @function parseobject
- @abstract Parses inline comments for a single function
- @author seek3r
- @syntax parseobject($input);
- @example $return_data = parseobject($doc_data);
+ /**
+ * Parses inline comments for a single function
+ *
+ * @author seek3r
+ * @param string $input Input for parsing @ commands
+ * @return array Name/value array
*/
function parseobject($input)
{
@@ -91,12 +100,12 @@
return Array('name' => $t, 'value' => $output[$t]);
}
- /*!
- @function parsesimpleobject
- @abstract Parses inline comments for a single function, in a more
limited fashion
- @author seek3r
- @syntax parsesimpleobject($input);
- @example $return_data = parsesimpleobject($simple_doc_data);
+ /**
+ * Parses inline comments for a single function, in a more limited
fashion
+ *
+ * @author seek3r
+ * @param string $input
+ * @return array Name/value pair array
*/
function parsesimpleobject($input)
{
@@ -144,10 +153,10 @@
return Array('name' => $t, 'value' => $output[$t]);
}
-
/**************************************************************************\
- * This section handles processing most of the input params for
*
- * limiting and selecting what to print
*
-
\**************************************************************************/
+ //
**************************************************************************
+ // This section handles processing most of the input params for
+ // limiting and selecting what to print
+ //
**************************************************************************
if (!isset($GLOBALS['HTTP_GET_VARS']['object_type']))
{
@@ -201,17 +210,17 @@
sort($files);
}
-
/**************************************************************************\
- * Now that I have the list of files, I loop thru all of them and get
the *
- * inline comments from them and load each of them into an array
*
-
\**************************************************************************/
+
//**************************************************************************
+ // Now that I have the list of files, I loop thru all of them and get
the
+ // inline comments from them and load each of them into an array
+
//**************************************************************************
while (list($p,$fn) = each($files))
{
$matches = $elements = $data = $startstop = array();
$string = $t = $out = $xkey = $new = '';
$file = '../'.$app.'/inc/' . $fn;
-// echo 'Looking at: ' . $file . "<br>\n";
+// echo 'Looking at: ' . $file . "<br />\n";
$f = fopen($file,'r');
while (!feof($f))
{
@@ -221,10 +230,10 @@
preg_match_all("#\*\!(.*)\*/#sUi",$string,$matches,PREG_SET_ORDER);
-
/**************************************************************************\
- * Now that I have the list of found inline docs, I need to
figure out *
- * which group they belong to.
*
-
\**************************************************************************/
+ //
**************************************************************************
+ // Now that I have the list of found inline docs, I need to
figure out
+ // which group they belong to.
+ //
**************************************************************************
$idx = 0;
$ssmatches = $matches;
reset($ssmatches);
@@ -273,7 +282,7 @@
$startstop[$idx] =
'some_lame_string_that_wont_be_used_by_a_function';
}
}
- $idx = $idx + 1;
+ ++$idx;
}
unset($ssmatches);
unset($sskey);
@@ -283,12 +292,12 @@
unset($idx);
reset($startstop);
-
/**************************************************************************\
- * Now that I have the list groups and which records belong in
which groups *
- * its time to parse each function and stick it under the
appropriate group *
- * if there is no defined group for a function, then it gets
tossed under *
- * a special group named by the file it was found in
*
-
\**************************************************************************/
+ //
**************************************************************************
+ // Now that I have the list groups and which records belong in
which groups
+ // its time to parse each function and stick it under the
appropriate group
+ // if there is no defined group for a function, then it gets
tossed under
+ // a special group named by the file it was found in
+ //
**************************************************************************
while (list($key,$val) = each($matches))
{
preg_match_all("#@(.*)$#sUi",$val[1],$data);
@@ -473,6 +482,6 @@
}
$GLOBALS['template']->fp('doc','border_bottom',True);
$GLOBALS['template']->pfp('out', 'doc');
- echo '<a name="array">';
+ echo '<a name="array"></a>';
array_print($doc_array);
?>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] phpgroupware/doc cvs_full_checkout.php, 1.14 inlinedocparser.php, 1.31,
powerstat <=
- Prev by Date:
[Phpgroupware-cvs] skel/help index.php,1.3
- Next by Date:
[Phpgroupware-cvs] phpgroupware soap.php, 1.9 index.php, 1.122 anon_wrapper.php, 1.7 set_box.php, 1.6 about.php, 1.26 notify.php, 1.14 login.php, 1.103 logout.php, 1.29 header.inc.php.template, 1.48 version.inc.php, 1.93 help.php, 1.4 home.php, 1.30 xmlrpc.php, 1.14 redirect.php, 1.3 notify_simple.php, 1.5
- Previous by thread:
[Phpgroupware-cvs] skel/help index.php,1.3
- Next by thread:
[Phpgroupware-cvs] phpgroupware soap.php, 1.9 index.php, 1.122 anon_wrapper.php, 1.7 set_box.php, 1.6 about.php, 1.26 notify.php, 1.14 login.php, 1.103 logout.php, 1.29 header.inc.php.template, 1.48 version.inc.php, 1.93 help.php, 1.4 home.php, 1.30 xmlrpc.php, 1.14 redirect.php, 1.3 notify_simple.php, 1.5
- Index(es):