Ignore:
Timestamp:
12/09/11 10:39:10 (13 years ago)
Author:
jkraaijeveld
Message:

Updated documentation and PHPDoc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Doc/Backend/PHPDoc/default/UserConnector.html

    r160 r179  
    1717        <div class="nav-bar">
    1818                                        <span class="disabled">Description</span> |
    19                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
     19                                                                                                        <a href="#sec-vars">Vars</a>
    2020                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    2121                                               
    2222                                        </div>
    2323        <div class="info-box-body">
    24                 <p class="implements">
    25             Implements interfaces:
    26             <ul>
    27                 <li><a href="../default/IConnector.html">IConnector</a></li>            </ul>
    28         </p>
    2924                        <!-- ========== Info from phpDoc block ========= -->
    3025<p class="short-description">Description of UserConnector</p>
     
    3732               
    3833                               
    39                 <pre></pre>
     34                <pre><a href="../default/Connector.html">Connector</a>
     35   |
     36   --UserConnector</pre>
    4037       
    4138                        </div>
     
    4441
    4542
    46         <a name="sec-var-summary"></a>
    47         <div class="info-box">
    48                 <div class="info-box-title">Variable Summary</span></div>
    49                 <div class="nav-bar">
    50                         <a href="#sec-description">Description</a> |
    51                                                 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    52                                                         |
    53                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    54                                                        
    55                                                                 </div>
    56                 <div class="info-box-body">
    57                         <div class="var-summary">
    58                                                                                                                                                                                                                                                                 <div class="var-title">
    59                                         <span class="var-type">mixed</span>
    60                                         <a href="#$fileName" title="details" class="var-name">$fileName</a>
    61                                 </div>
    62                                                                                                                                 <div class="var-title">
    63                                         <span class="var-type">mixed</span>
    64                                         <a href="#$model" title="details" class="var-name">$model</a>
    65                                 </div>
    66                                                                                         </div>
    67                 </div>
    68         </div>
    6943
    7044        <a name="sec-method-summary"></a>
     
    7347                <div class="nav-bar">
    7448                        <a href="#sec-description">Description</a> |
    75                                                                                                                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
     49                                                                                                                                                <a href="#sec-vars">Vars</a>
    7650                                 
    7751                                |
     
    8054                <div class="info-box-body">                     
    8155                        <div class="method-summary">
    82                                                                                                                                                                                                                                                                                                                                                                
     56                                                                                                                                                                                                                               
    8357                                                                                                <div class="method-definition">
    8458                                                                                        <span class="method-result">UserConnector</span>
     
    9367                                                                                                                                <div class="method-definition">
    9468                                                                                        <span class="method-result">void</span>
    95                                                                                 <a href="#load" title="details" class="method-name">load</a>
    96                                                                                 ()
    97                                                                         </div>
    98                                                                                                                                 <div class="method-definition">
    99                                                                                         <span class="method-result">void</span>
    100                                                                                 <a href="#save" title="details" class="method-name">save</a>
    101                                                                                 ()
    102                                                                         </div>
    103                                                                                                                                 <div class="method-definition">
    104                                                                                         <span class="method-result">void</span>
    10569                                                                                <a href="#set" title="details" class="method-name">set</a>
    10670                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$rToolObject</span>)
     
    12387                                        </div>
    12488                <div class="info-box-body">
    125                         <a name="var$fileName" id="$fileName"><!-- --></A>
    126 <div class="evenrow">
    127 
    128         <div class="var-header">
    129                 <span class="var-title">
    130                         <span class="var-type">mixed</span>
    131                         <span class="var-name">$fileName</span>
    132                          = <span class="var-default"> 'data/users/users.rdf'</span>                     (line <span class="line-number">15</span>)
    133                 </span>
    134         </div>
    135 
    136         <!-- ========== Info from phpDoc block ========= -->
    137         <ul class="tags">
    138                                 <li><span class="field">access:</span> protected</li>
    139                         </ul>
    140        
    141        
    142                
    143                
    144 
    145 </div>
    146 <a name="var$model" id="$model"><!-- --></A>
    147 <div class="oddrow">
    148 
    149         <div class="var-header">
    150                 <span class="var-title">
    151                         <span class="var-type">mixed</span>
    152                         <span class="var-name">$model</span>
    153                                                 (line <span class="line-number">14</span>)
    154                 </span>
    155         </div>
    156 
    157         <!-- ========== Info from phpDoc block ========= -->
    158         <ul class="tags">
    159                                 <li><span class="field">access:</span> protected</li>
    160                         </ul>
    161        
    162        
    163                
    164                
    165 
    166 </div>
    167                                                
     89                                                                                <h4>Inherited Variables</h4>
     90                                <A NAME='inherited_vars'><!-- --></A>
     91                                                                        <p>Inherited from <span class="classname"><a href="../default/Connector.html">Connector</a></span></p>
     92                                        <blockquote>
     93                                                                                                        <span class="var-title">
     94                                                                <span class="var-name"><a href="../default/Connector.html#var$fileName">Connector::$fileName</a></span><br>
     95                                                        </span>
     96                                                                                                        <span class="var-title">
     97                                                                <span class="var-name"><a href="../default/Connector.html#var$model">Connector::$model</a></span><br>
     98                                                        </span>
     99                                                                                                        <span class="var-title">
     100                                                                <span class="var-name"><a href="../default/Connector.html#var$type">Connector::$type</a></span><br>
     101                                                        </span>
     102                                                                                        </blockquote>
     103                                                                               
    168104                </div>
    169105        </div>
     
    174110                <div class="nav-bar">
    175111                        <a href="#sec-description">Description</a> |
    176                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
     112                                                                                                                        <a href="#sec-vars">Vars</a>
    177113                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    178114                                               
     
    185121       
    186122        <div class="method-header">
    187                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">20</span>)
     123                <span class="method-title">Constructor __construct</span> (line <span class="line-number">17</span>)
    188124        </div>
    189125       
    190126        <!-- ========== Info from phpDoc block ========= -->
    191 <p class="short-description">Constructor for RespondentConnector.</p>
     127<p class="short-description">Constructor for UserConnector.</p>
    192128        <ul class="tags">
    193129                                <li><span class="field">access:</span> public</li>
     
    209145       
    210146        <div class="method-header">
    211                 <span class="method-title">get</span> (line <span class="line-number">53</span>)
     147                <span class="method-title">get</span> (line <span class="line-number">31</span>)
    212148        </div>
    213149       
     
    232168                                </ul>
    233169               
    234                                 <hr class="separator" />
    235                 <div class="notes">Implementation of:</div>
    236                         <dl>
    237                         <dt><a href="../default/IConnector.html#methodget">IConnector::get()</a></dt>
    238                                         </dl>
    239                        
    240         </div>
    241 <a name="methodload" id="load"><!-- --></a>
    242 <div class="evenrow">
    243        
    244         <div class="method-header">
    245                 <span class="method-title">load</span> (line <span class="line-number">31</span>)
    246         </div>
    247        
    248         <!-- ========== Info from phpDoc block ========= -->
    249 <p class="short-description">function load()  Loads the file into the standard MemModel.</p>
    250         <ul class="tags">
    251                                 <li><span class="field">access:</span> public</li>
    252                         </ul>
    253        
    254         <div class="method-signature">
    255                 <span class="method-result">void</span>
    256                 <span class="method-name">
    257                         load
    258                 </span>
    259                                 ()
    260                         </div>
    261        
    262                
    263                                 <hr class="separator" />
    264                 <div class="notes">Implementation of:</div>
    265                         <dl>
    266                         <dt><a href="../default/IConnector.html#methodload">IConnector::load()</a></dt>
    267                                         </dl>
    268                        
    269         </div>
    270 <a name="methodsave" id="save"><!-- --></a>
    271 <div class="oddrow">
    272        
    273         <div class="method-header">
    274                 <span class="method-title">save</span> (line <span class="line-number">43</span>)
    275         </div>
    276        
    277         <!-- ========== Info from phpDoc block ========= -->
    278 <p class="short-description">function save()  Saves the MemModel into the given file.</p>
    279         <ul class="tags">
    280                                 <li><span class="field">access:</span> public</li>
    281                         </ul>
    282        
    283         <div class="method-signature">
    284                 <span class="method-result">void</span>
    285                 <span class="method-name">
    286                         save
    287                 </span>
    288                                 ()
    289                         </div>
    290        
    291                
    292                                 <hr class="separator" />
    293                 <div class="notes">Implementation of:</div>
    294                         <dl>
    295                         <dt><a href="../default/IConnector.html#methodsave">IConnector::save()</a></dt>
    296                                         </dl>
    297170                       
    298171        </div>
     
    301174       
    302175        <div class="method-header">
    303                 <span class="method-title">set</span> (line <span class="line-number">98</span>)
     176                <span class="method-title">set</span> (line <span class="line-number">64</span>)
    304177        </div>
    305178       
     
    324197                                </ul>
    325198               
    326                                 <hr class="separator" />
    327                 <div class="notes">Implementation of:</div>
    328                         <dl>
    329                         <dt><a href="../default/IConnector.html#methodset">IConnector::set()</a></dt>
    330                                         </dl>
    331                        
    332         </div>
    333                                                
     199                       
     200        </div>
     201                                                        <h4>Inherited Methods</h4>
     202                                <a name='inherited_methods'><!-- --></a>       
     203                                                                        <!-- =========== Summary =========== -->
     204                                        <p>Inherited From <span class="classname"><a href="../default/Connector.html">Connector</a></span></p>
     205                                        <blockquote>
     206                                                                                                        <span class="method-name"><a href="../default/Connector.html#methodcreateArguments">Connector::createArguments()</a></span><br>
     207                                                                                                        <span class="method-name"><a href="../default/Connector.html#methodload">Connector::load()</a></span><br>
     208                                                                                                        <span class="method-name"><a href="../default/Connector.html#methodsave">Connector::save()</a></span><br>
     209                                                                                        </blockquote>
     210                                                                               
    334211                </div>
    335212        </div>
     
    337214
    338215        <p class="notes" id="credit">
    339                 Documentation generated on Fri, 18 Nov 2011 12:57:06 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
     216                Documentation generated on Fri, 09 Dec 2011 09:33:27 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    340217        </p>
    341218        </div></body>
Note: See TracChangeset for help on using the changeset viewer.