cvs: php4 /pear/PHPDoc/accessor PhpdocDocumentAccessor.php PhpdocIndexAccessor.php

uw Sun Dec 3 13:12:27 2000 EDT Modified files: /php4/pear/PHPDoc/accessor PhpdocDocumentAccessor.php PhpdocIndexAccessor.php Log: - refined the doc comments Index: php4/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php diff -u php4/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php:1.1 php4/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php:1.2 --- php4/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php:1.1 Sun Oct 8 03:03:18 2000 +++ php4/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php Sun Dec 3 13:12:27 2000 @@ -15,6 +15,7 @@ /** * Returns an array with all functions. + * * @return array $functions * @access public * @see getFunctionsByAccess() @@ -25,6 +26,7 @@ /** * Returns an array with all functions with a certain access (public, private) attribute. + * * @param string Requested access attribute. * @return array $functions * @access public @@ -36,6 +38,7 @@ /** * Returns an array with all variables. + * * @return array $variables * @access public * @see getVariablesByAccess() @@ -46,6 +49,7 @@ /** * Returns an array with all variables with a certain access (public, private) attribute. + * * @param string Requested access attribute. * @return array $variables * @access public @@ -57,6 +61,7 @@ /** * Returns an array of all constants. + * * @return array $constants * @access public * @see getConstantsByAccess() @@ -67,6 +72,7 @@ /** * Returns an array of all constants with a certain access (public, private) attribute. + * * @param string Requested access attribute. * @return array $constants * @see getConstants() @@ -78,6 +84,7 @@ /** * Returns an array of all included files. + * * @return array $uses * @see getUsesByType() * @access public @@ -88,6 +95,7 @@ /** * Returns an array of all included files with a certain type (include, require...) attribute. + * * @param string Requested type: include, include_once, require, require_once * @return array $uses * @access public @@ -172,7 +180,7 @@ } // end func getElementsByAccess /** - * Adds a list of @included files to the internal data array. + * Adds a list of included files to the internal data array. */ function buildUseslist() { @@ -204,6 +212,7 @@ /** * Adds a list of a certain element to the internal data array. + * * @param string name of the element to add: function, variable, constant. */ function getElementlist($element) { Index: php4/pear/PHPDoc/accessor/PhpdocIndexAccessor.php diff -u php4/pear/PHPDoc/accessor/PhpdocIndexAccessor.php:1.1 php4/pear/PHPDoc/accessor/PhpdocIndexAccessor.php:1.2 --- php4/pear/PHPDoc/accessor/PhpdocIndexAccessor.php:1.1 Sun Oct 8 03:03:18 2000 +++ php4/pear/PHPDoc/accessor/PhpdocIndexAccessor.php Sun Dec 3 13:12:27 2000 @@ -6,36 +6,42 @@ /** * Ordered list of all chapternames. + * * @var array */ var $chapternames = array(); /** * Ordered list of all chapters. + * * @var array */ var $chapters = array(); /** * List of all packages. + * * @var array */ var $packages = array(); /** * Data of a classtree + * * @var array */ var $classtree = array(); /** * Data of a modulegroup + * * @var array */ var $modulegroup = array(); /** * Some container withing the packagelist. + * * @var array * @see buildPackagelist() */ @@ -43,6 +49,7 @@ /** * Flag indicating that certain internal datafield have been filled. + * * @var array */ var $flagBuild = array( @@ -261,7 +268,7 @@ /** * Extracts the modulegroup data of the xml file. * - * @see getModulegroup + * @see getModulegroup() */ function buildModulegroup() {