LJCDocDataFile

/ LJCPHPCodeDoc / LJCDocDataLib / LJCDocDataFile

Syntax

PHP
class LJCDocDataFile

Represents DocData Lib File XML Comments.

Remarks

The DocData XML is intended to contain the XML Comments based on the PHP file structure of Classes, Methods and Properties.

 <LJCDocDataFile>
   <Name/>
   <Summary/>
   <Remarks/>
   <Classes>
     <Class>
       <Name/>
       <Summary/>
       <Remarks/>
       <Methods>
         <Method>
           <Name/>
           <Summary/>
           <Params>
             <Param>
               <Name/>
               <Summary/>
             </Param>
           </Params>
           <Remarks/>
           <Returns/>
           <Syntax/>
           <Code/>
         </Method>
       </Methods>
       <Properties>
         <Property>
           <Name/>
           <Summary/>
           <Syntax/>
         </Property>
       </Properties>
     </Class>
   </Classes>
 </LJCDocDataFile>

Public Functions

Deserialize	Deserializes the data from an LJCDocDataFile XML file.
DeserializeString	Deserializes the data from an LJCDocDataFile XML string.
construct	Deserialize Properties from the Class node.
Clone	Creates a Clone of the current object.
Serialize	Writes the serialized XML.
SerializeGroups	_FunctionSummary_
SerializeToString	_FunctionSummary_

7 Functions

Public Properties

$Classes	The Class collection.
$Functions	The Function array.
$Name	The Name value.
$Remarks	The Name value.
$Summary	The Summary value.