Changeset 750

Show
Ignore:
Timestamp:
12/28/07 13:18:50 (13 months ago)
Author:
michiel
Message:

regenerated documentation

Location:
docs/phpdoc_generated
Files:
11 added
61 modified

Legend:

Unmodified
Added
Removed
  • docs/phpdoc_generated/MvBlog/MvBlog.html

    </
    r589 r750  
    7171                <div class="info-box-body">                      
    7272                        <div class="method-summary"> 
    73                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
     73                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
    7474                                                                                                <div class="method-definition"> 
    7575                                                                                        <span class="method-result">MvBlog</span> 
    7676                                                                                <a href="#__construct" title="details" class="method-name">__construct</a> 
    77                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$basedir</span> = <span class="var-default">&quot;&quot;</span>]) 
     77                                                                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$basedir</span> = <span class="var-default">&quot;&quot;</span>]) 
    7878                                                                        </div> 
    7979                                                                                                                                <div class="method-definition"> 
    8080                                                                                        <span class="method-result">void</span> 
    8181                                                                                <a href="#blog_archive_links" title="details" class="method-name">blog_archive_links</a> 
    82                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$amount</span> = <span class="var-default">5</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$ammount</span>) 
     82                                                                                        ([<span class="var-type">int</span>&nbsp;<span class="var-name">$amount</span> = <span class="var-default">5</span>]) 
    8383                                                                        </div> 
    8484                                                                                                                                <div class="method-definition"> 
     
    109109                                                                                                                                <div class="method-definition"> 
    110110                                                                                        <span class="method-result">void</span> 
     111                                                                                <a href="#blog_show_dossierlinks" title="details" class="method-name">blog_show_dossierlinks</a> 
     112                                                                                () 
     113                                                                        </div> 
     114                                                                                                                                <div class="method-definition"> 
     115                                                                                        <span class="method-result">void</span> 
    111116                                                                                <a href="#blog_show_login" title="details" class="method-name">blog_show_login</a> 
    112117                                                                                () 
     
    135140                                                                                        <span class="method-result">void</span> 
    136141                                                                                <a href="#get_articles" title="details" class="method-name">get_articles</a> 
    137                                                                                         (<span class="var-type">int</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$archive</span> = <span class="var-default">0</span>]) 
     142                                                                                        (<span class="var-type">int</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$archive</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$dossier</span> = <span class="var-default">0</span>]) 
    138143                                                                        </div> 
    139144                                                                                                                                <div class="method-definition"> 
     
    145150                                                                                        <span class="method-result">int</span> 
    146151                                                                                <a href="#limit_text" title="details" class="method-name">limit_text</a> 
    147                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$text</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$length</span> = <span class="var-default">4000</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>) 
     152                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">&$text</span>) 
    148153                                                                        </div> 
    149154                                                                                                                                <div class="method-definition"> 
     
    164169                                                                                                                                <div class="method-definition"> 
    165170                                                                                        <span class="method-result">void</span> 
    166                                                                                 <a href="#register_confirm" title="details" class="method-name">register_confirm</a> 
    167                                                                                 () 
    168                                                                         </div> 
    169                                                                                                                                 <div class="method-definition"> 
    170                                                                                         <span class="method-result">void</span> 
    171                                                                                 <a href="#register_save" title="details" class="method-name">register_save</a> 
    172                                                                                 () 
    173                                                                         </div> 
    174                                                                                                                                 <div class="method-definition"> 
    175                                                                                         <span class="method-result">void</span> 
    176                                                                                 <a href="#register_user" title="details" class="method-name">register_user</a> 
    177                                                                                 () 
    178                                                                         </div> 
    179                                                                                                                                 <div class="method-definition"> 
    180                                                                                         <span class="method-result">void</span> 
    181171                                                                                <a href="#show_article" title="details" class="method-name">show_article</a> 
    182172                                                                                        (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$captcha_error</span> = <span class="var-default">0</span>]) 
     173                                                                        </div> 
     174                                                                                                                                <div class="method-definition"> 
     175                                                                                        <span class="method-result">void</span> 
     176                                                                                <a href="#show_comment" title="details" class="method-name">show_comment</a> 
     177                                                                                        (<span class="var-type">array</span>&nbsp;<span class="var-name">$commentdata</span>) 
    183178                                                                        </div> 
    184179                                                                                                                                <div class="method-definition"> 
     
    193188                                                                        </div> 
    194189                                                                                                                                <div class="method-definition"> 
     190                                                                                        <span class="method-result">void</span> 
     191                                                                                <a href="#user_confirm" title="details" class="method-name">user_confirm</a> 
     192                                                                                () 
     193                                                                        </div> 
     194                                                                                                                                <div class="method-definition"> 
     195                                                                                        <span class="method-result">void</span> 
     196                                                                                <a href="#user_edit" title="details" class="method-name">user_edit</a> 
     197                                                                                        ([<span class="var-type">int</span>&nbsp;<span class="var-name">$register</span> = <span class="var-default">1</span>]) 
     198                                                                        </div> 
     199                                                                                                                                <div class="method-definition"> 
    195200                                                                                        <span class="method-result">bool</span> 
    196201                                                                                <a href="#user_login" title="details" class="method-name">user_login</a> 
    197202                                                                                        (<span class="var-type">array</span>&nbsp;<span class="var-name">$userdata</span>) 
     203                                                                        </div> 
     204                                                                                                                                <div class="method-definition"> 
     205                                                                                        <span class="method-result">void</span> 
     206                                                                                <a href="#user_save" title="details" class="method-name">user_save</a> 
     207                                                                                () 
    198208                                                                        </div> 
    199209                                                                </div> 
     
    295305         
    296306        <div class="method-header"> 
    297                 <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a77">77</a></span>) 
     307                <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a78">78</a></span>) 
    298308        </div>  
    299309         
     
    309319                        __construct 
    310320                </span> 
    311                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$basedir</span> = <span class="var-default">&quot;&quot;</span>]) 
    312                         </div> 
    313          
    314                         <ul class="parameters"> 
    315                                         <li> 
    316                                 <span class="var-type"></span> 
    317                                 <span class="var-name">$basedir</span>                  </li> 
     321                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$basedir</span> = <span class="var-default">&quot;&quot;</span>]) 
     322                        </div> 
     323         
     324                        <ul class="parameters"> 
     325                                        <li> 
     326                                <span class="var-type">string</span> 
     327                                <span class="var-name">$basedir</span><span class="var-description">: If set use this directory where MvBlog is located.</span>                 </li> 
    318328                                </ul> 
    319329                 
     
    330340         
    331341        <div class="method-header"> 
    332                 <span class="method-title">blog_archive_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a810">810</a></span>) 
     342                <span class="method-title">blog_archive_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a862">862</a></span>) 
    333343        </div>  
    334344         
     
    344354                        blog_archive_links 
    345355                </span> 
    346                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$amount</span> = <span class="var-default">5</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$ammount</span>) 
     356                                        ([<span class="var-type">int</span>&nbsp;<span class="var-name">$amount</span> = <span class="var-default">5</span>]) 
    347357                        </div> 
    348358         
     
    350360                                        <li> 
    351361                                <span class="var-type">int</span> 
    352                                 <span class="var-name">$ammount</span><span class="var-description">: The number of months to show</span>                       </li> 
    353                                         <li> 
    354                                 <span class="var-type"></span> 
    355                                 <span class="var-name">$amount</span>                   </li> 
     362                                <span class="var-name">$amount</span><span class="var-description">: The number of months to show</span>                        </li> 
    356363                                </ul> 
    357364                 
     
    362369         
    363370        <div class="method-header"> 
    364                 <span class="method-title">blog_cats_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a851">851</a></span>) 
     371                <span class="method-title">blog_cats_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a903">903</a></span>) 
    365372        </div>  
    366373         
     
    386393         
    387394        <div class="method-header"> 
    388                 <span class="method-title">blog_content</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a128">128</a></span>) 
     395                <span class="method-title">blog_content</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a129">129</a></span>) 
    389396        </div>  
    390397         
     
    418425         
    419426        <div class="method-header"> 
    420                 <span class="method-title">blog_default_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a752">752</a></span>) 
     427                <span class="method-title">blog_default_links</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a801">801</a></span>) 
    421428        </div>  
    422429         
     
    442449         
    443450        <div class="method-header"> 
    444                 <span class="method-title">blog_get_description</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a112">112</a></span>) 
     451                <span class="method-title">blog_get_description</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a113">113</a></span>) 
    445452        </div>  
    446453         
     
    467474         
    468475        <div class="method-header"> 
    469                 <span class="method-title">blog_get_title</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a97">97</a></span>) 
     476                <span class="method-title">blog_get_title</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a98">98</a></span>) 
    470477        </div>  
    471478         
     
    488495                         
    489496        </div> 
     497<a name="methodblog_show_dossierlinks" id="blog_show_dossierlinks"><!-- --></a> 
     498<div class="oddrow"> 
     499         
     500        <div class="method-header"> 
     501                <span class="method-title">blog_show_dossierlinks</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a970">970</a></span>) 
     502        </div>  
     503         
     504        <!-- ========== Info from phpDoc block ========= --> 
     505<p class="short-description">Show list of dossiers.</p> 
     506        <ul class="tags"> 
     507                                <li><span class="field">access:</span> public</li> 
     508                        </ul> 
     509         
     510        <div class="method-signature"> 
     511                <span class="method-result">void</span> 
     512                <span class="method-name"> 
     513                        blog_show_dossierlinks 
     514                </span> 
     515                                () 
     516                        </div> 
     517         
     518                 
     519                         
     520        </div> 
    490521<a name="methodblog_show_login" id="blog_show_login"><!-- --></a> 
    491 <div class="oddrow"> 
    492          
    493         <div class="method-header"> 
    494                 <span class="method-title">blog_show_login</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a727">727</a></span>) 
     522<div class="evenrow"> 
     523         
     524        <div class="method-header"> 
     525                <span class="method-title">blog_show_login</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a776">776</a></span>) 
    495526        </div>  
    496527         
     
    513544        </div> 
    514545<a name="methodblog_show_menulinks" id="blog_show_menulinks"><!-- --></a> 
    515 <div class="evenrow"> 
    516          
    517         <div class="method-header"> 
    518                 <span class="method-title">blog_show_menulinks</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a899">899</a></span>) 
     546<div class="oddrow"> 
     547         
     548        <div class="method-header"> 
     549                <span class="method-title">blog_show_menulinks</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a951">951</a></span>) 
    519550        </div>  
    520551         
     
    537568        </div> 
    538569<a name="methodblog_show_search" id="blog_show_search"><!-- --></a> 
    539 <div class="oddrow"> 
    540          
    541         <div class="method-header"> 
    542                 <span class="method-title">blog_show_search</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a885">885</a></span>) 
     570<div class="evenrow"> 
     571         
     572        <div class="method-header"> 
     573                <span class="method-title">blog_show_search</span> (line <span class="line-number"><a href="../__filesource/fsource_MvBlog__commonmvblog.php.html#a937">937</a></span>)