<?xml version="1.0"?><phpdoc><class name="PhpdocClassAnalyser" extends="PhpdocAnalyser" undoc="false" access="private" package="PHPDoc"><file>c:/www/apache/doc2//analyser/PhpdocClassAnalyser.php</file><doc><author email="ulf.wendel@phpdoc.de">Ulf Wendel</author><inherited src="Array"/><overriden src="Array"/><description/><shortdescription>Analyses a class.</shortdescription><version>$Id: $</version></doc><function name="setClasses" undoc="false" access="public"><doc><parameter name="$classes" type="array">class data from the parser</parameter><parameter name="$baseclass" type="string">of the baseclass of the given classes</parameter><return type="void"/><description/><shortdescription>Sets the class data and the name of the baseclass.</shortdescription></doc></function><function name="getClass" undoc="false" access="public"><doc><return name="" type="mixed">False if there no classes anymore, otherwise an array with&#x0a;the data of the class.</return><description/><shortdescription>Returns an analysed class or false if there&amp;apos;re no classes any more.</shortdescription></doc></function><function name="findUndocumented" undoc="true" access="private"><doc><parameter name="$classname" type="string"/><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Looks for undocumented elements in a certain class</shortdescription></doc></function><function name="checkFunctionArgs" undoc="true" access="private"><doc><parameter name="$classname" type="string"/><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Checks the function documentation of a certain class.</shortdescription></doc></function><function name="buildBottomUpClasslist" undoc="false" access="private"><doc><see type="var">$classlist</see><parameter name="$classname" type="string">of the class that starts the recursive build process.</parameter><return type="void"/><description>The analyser needs an ordered list of all classesto inherit information effective.</description><shortdescription>Builds an internal list of all classes.</shortdescription></doc></function><function name="inheritClassElements" undoc="false" access="private"><doc><see type="var">$classes</see><see type="var">$notinherited</see><see type="function">addInheritedElements()</see><parameter name="$classname" type="string"/><return name="$ok" type="boolean"/><description/><shortdescription>Adds inherited elements to a class.</shortdescription></doc></function><function name="addInheritedElements" undoc="false" access="private"><doc><see type="var">$classes</see><see type="var">$notinherited</see><see type="function">isUndocumented()</see><parameter name="$classname" type="string">of the class that inherits the informations.</parameter><parameter name="$parentclass" type="string">of the parentclass</parameter><parameter name="$type" type="string">of elements inherited: &amp;quot;functions&amp;quot;, &amp;quot;variables&amp;quot;, &amp;quot;uses&amp;quot;, &amp;quot;consts&amp;quot;</parameter><return name="$ok" type="boolean"/><description/><shortdescription>Adds inherited functions, variables, constants or included files to a class.</shortdescription></doc></function><function name="isUndocumented" undoc="false" access="private"><doc><parameter name="$classname" type="string">of the class of the element</parameter><parameter name="$type" type="string">type: functions, variables, uses, consts.</parameter><parameter name="$elementname" type="string">name</parameter><return name="$ok" type="boolean"/><description>The function checks if the element might inherit documentationfrom any parentclass.</description><shortdescription>Returns true if the requested element is undocumented and false if it&amp;apos;s documented.</shortdescription></doc></function><function name="updateBrotherSisterElements" undoc="true" access="private"><doc><parameter name="$classname" type="string">of the class to update</parameter><parameter name="$type" type="string">: functions, variables, ...</parameter><return name="" type="boolean"/><overriden src="PhpdocAnalyser"/><description/><shortdescription/></doc></function><function name="updateAccessReturnElements" undoc="true" access="private"><doc><see type="function">updateAccessReturn()</see><parameter name="$classname" type="string"/><parameter name="$type" type="string">type: functions (, variables, consts, uses)</parameter><return name="$ok" type="boolean"/><overriden src="PhpdocAnalyser"/><description>This function should only be used to update functions.Functions that have the same name as the class (constructors)get return void and access public. Functions withoutaccess get access public and functions without return getreturn void.</description><shortdescription>Updates access and return for certain elements.</shortdescription></doc></function><function name="updateAccessElements" undoc="true" access="private"><doc><see type="function">updateAccessReturnElements()</see><parameter name="$classname" type="string"/><parameter name="$type" type="string">type: functions, variables, consts (, uses)</parameter><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Updates access tags.</shortdescription></doc></function><function name="checkSeeElements" undoc="false" access="private"><doc><parameter name="$elements" type="array">of functions, variables,...</parameter><parameter name="$classname" type="string">of the class that contains the given elements.</parameter><parameter name="$eltype" type="string">: functions, variables, consts, uses.</parameter><return type="void"/><description>References to variables and functions within the same class get checked.It the references element does not exist, the reference gets deleted anda doc warning gets generated.</description><shortdescription>Checks see references in the given element array (functions, variables...)</shortdescription></doc></function><function name="buildElementlist" undoc="true" access="private"><doc><see type="var">$elementlist</see><parameter name="$classname" type="string">of the class to scan.</parameter><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Builds an array with all elements of a class and saves it to $this-&amp;gt;elementlist.</shortdescription></doc></function><function name="analyse" undoc="true" access="private"><doc><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Starts the analysing of the raw parsing data.</shortdescription></doc></function><function name="updateBrothersSisters" undoc="true" access="private"><doc><see type="function">updateBrotherSisterElements()</see><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Handles brother and sister.</shortdescription></doc></function><function name="updateAccessReturn" undoc="true" access="private"><doc><see type="function">updateAccessReturnElements()</see><see type="function">updateAccessElements()</see><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Updates the access and return tag values.</shortdescription></doc></function><function name="checkSee" undoc="true" access="private"><doc><return type="void"/><overriden src="PhpdocAnalyser"/><description/><shortdescription>Checks all see references in the given classes/modulegroup.</shortdescription></doc></function><variable name="$classes" access="private" type="array">array()<doc><description/><shortdescription>Class data.</shortdescription></doc></variable><variable name="$baseclass" access="private" type="string">&amp;quot;&amp;quot;<doc><description/><shortdescription>Name of the baseclass of the given classes.</shortdescription></doc></variable><variable name="$classlist" access="private" type="array">array()<doc><description/><shortdescription>Ordered list of all classes.</shortdescription></doc></variable><variable name="$notinherited" access="private" type="array">array(&#x0a;															&amp;quot;class&amp;quot;	=&amp;gt; array(&#x0a;																								&amp;quot;name&amp;quot;			=&amp;gt; true,&#x0a;																								&amp;quot;extends&amp;quot;		=&amp;gt; true,&#x0a;																								&amp;quot;undoc&amp;quot;			=&amp;gt; true,&#x0a;																								&amp;quot;variables&amp;quot;	=&amp;gt; true,&#x0a;																								&amp;quot;functions&amp;quot;	=&amp;gt; true,&#x0a;																								&amp;quot;consts&amp;quot;		=&amp;gt; true,&#x0a;																								&amp;quot;uses&amp;quot;			=&amp;gt; true,&#x0a;																								&amp;quot;filename&amp;quot;	=&amp;gt; true,&#x0a;																								&amp;quot;subclasses&amp;quot;=&amp;gt; true,&#x0a;																								&amp;quot;path&amp;quot;			=&amp;gt; true,&#x0a;																								&amp;quot;baseclass&amp;quot;	=&amp;gt; true,&#x0a;																								&amp;quot;abstract&amp;quot;	=&amp;gt; true&#x0a;																							),&#x0a;																							&#x0a;															&amp;quot;functions&amp;quot;	=&amp;gt; array(&#x0a;																										&amp;quot;name&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;undoc&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;inherited&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;overrides&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;abstract&amp;quot;	=&amp;gt; true&#x0a;																									),&#x0a;																									&#x0a;															&amp;quot;variables&amp;quot;	=&amp;gt; array(&#x0a;																										&amp;quot;name&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;undoc&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;inherited&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;overrides&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;abstract&amp;quot;	=&amp;gt; true&#x0a;																									),	&#x0a;																									&#x0a;															&amp;quot;uses&amp;quot;			=&amp;gt; array(&#x0a;																										&amp;quot;name&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;undoc&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;inherited&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;overrides&amp;quot;	=&amp;gt; true&#x0a;																									),																																																								&#x0a;															&#x0a;															&amp;quot;consts&amp;quot;	=&amp;gt; array(&#x0a;																										&amp;quot;name&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;undoc&amp;quot;			=&amp;gt; true,&#x0a;																										&amp;quot;inherited&amp;quot;	=&amp;gt; true,&#x0a;																										&amp;quot;overrides&amp;quot;	=&amp;gt; true&#x0a;																									)																														&#x0a;													)<doc><description/><shortdescription>List of not inherited elements.</shortdescription></doc></variable><variable name="$undocumentedFields" access="private" type="array">array(&#x0a;															&amp;quot;functions&amp;quot;	=&amp;gt; &amp;quot;function&amp;quot;,&#x0a;															&amp;quot;variables&amp;quot;	=&amp;gt; &amp;quot;variable&amp;quot;,&#x0a;															&amp;quot;uses&amp;quot;			=&amp;gt; &amp;quot;included file&amp;quot;,&#x0a;															&amp;quot;consts&amp;quot;		=&amp;gt; &amp;quot;constant&amp;quot;&#x0a;													)<doc><see type="function">findUndocumented()</see><description/><shortdescription>Puuuh - findUndocumented() needs this.</shortdescription></doc></variable><inherited src="PhpdocAnalyser" type="functions"><element>addnumbersuffix</element><element>copybrothersisterfields</element><element>checkseeelement</element><element>checkargdocs</element></inherited><inherited src="PhpdocObject" type="functions"><element>setflagoutput</element><element>out</element><element>nametourl</element><element>outl</element><element>introspection</element></inherited><inherited src="PhpdocAnalyser" type="variables"><element>$flag_get</element><element>$elementlist</element></inherited><inherited src="PhpdocObject" type="variables"><element>$err</element><element>$application</element><element>$warn</element><element>$flag_output</element></inherited><path><parent>PhpdocAnalyser</parent><parent>PhpdocObject</parent></path><baseclass>PhpdocObject</baseclass></class></phpdoc>
