Documentation of Guide

Niouzes

< Février 2021 >
Lu	Ma	Me	Je	Ve	Sa	Di
1	2	3	4	5	6	7
8	9	10	11	12	13	14
15	16	17	18	19	20	21
22	23	24	25	26	27	28

Citation

2013-10-05 à 15:42:28 par Patrick Boens

Documentation of Guide

Introduction

Guide is the Vae Soli! tool that is used to generate the documentation of … Vae Soli!. As in Javadoc or PHPDoc it uses comment markers to delimit the parts that form documentation extracts. However, Vae Soli!'s implementation differs largely from PHPDoc in the sense that it does NOT use DocBlock comments at all. Still the basic principle is pretty much the same.

Guide is made of routines that come straight from Vae Soli!. It means that Vae Soli! is used to document Vae Soli!. Moreover, as Guide is used to document Guide this is considered as complete double looping.

File headers

{{{*fheader … *}}}

Inner Guide tags

{*file … *}: physical filename

{*purpose … *}: purpose of the whole file

{*author … *}: author of the file

{*lastmodby … *}: person that made the last modification to the file (if different from author)

{*company … *}: company info

{*cdate … *}: creation date of the file

{*mdate … *}: last modification date. Set it to 'auto' for automatic detection

{*license … *}: license to be considered

{*chist … *}: change history item

{*doc … *}: additional documentation

{*todo … *}: TODO notes

… is a placeholder for the text that is to be extracted.

Example

/**************************************************************************/
/** {{{*fheader
    {*file                  LSLoginQuitus.class.php *}
    {*purpose               Login/Logoff service for Quitus *}
    {*author                Patrick Boens *}
    {*company               Lato Sensu Management[br]
                            Rue Bois des Mazuis, 47[br]
                            5070 Vitrival[br]
                            Belgium[br]
                            [url]http://www.latosensu.be[/url][br]
                            Vae Soli! : [url]http://www.vaesoli.org[/url]
    *}
    {*cdate                 13/11/2011 - 18:28 *}
    {*mdate                 auto *}
    {*license               [url]http://creativecommons.org/licenses/by-sa/2.0/be/[/url][br]

                            To obtain detailed information about the license
                            terms, please head to the full license text
                            available in the [file]LSCopyright.php[/file] file *}

    {*chist
        {*mdate 13/09/2013 *}
        {*v 5.5.0000 *}
        {*desc              1)  Comments à la guide
                            2)  Level up to Coding Rules
        *}
    *}

    *}}} */
/**************************************************************************/

D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php:3672:
object(LogicException)[99]
  protected 'message' => string 'Class LSContentsCookieUsage could not be loaded' (length=47)
  private 'string' (Exception) => string '' (length=0)
  protected 'code' => int 0
  protected 'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
  protected 'line' => int 3601
  private 'trace' (Exception) => 
    array (size=16)
      0 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3601
          'function' => string 'spl_autoload' (length=12)
          'args' => 
            array (size=1)
              ...
      1 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3276
          'function' => string 'EmergeIsland' (length=12)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=6)
              ...
      2 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 2770
          'function' => string 'EmergeIslands' (length=13)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=5)
              ...
      3 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3008
          'function' => string 'EmergeArchipelagosFromParent' (length=28)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=3)
              ...
      4 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5928
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=2)
              ...
      5 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5940
          'function' => string 'Land' (length=4)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      6 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\template\vaesoli.html' (length=58)
          'line' => int 135
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      7 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6110
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
      8 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6053
          'function' => string 'XInclude' (length=8)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      9 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5828
          'function' => string 'IncludeTemplate' (length=15)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      10 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5580
          'function' => string 'UseTemplate' (length=11)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      11 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 3282
          'function' => string 'RenderXML' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      12 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 2082
          'function' => string 'StartPage' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      13 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSApplication.class.php' (length=76)
          'line' => int 814
          'function' => string 'Render' (length=6)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      14 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\master.php' (length=47)
          'line' => int 8
          'function' => string 'Run' (length=3)
          'class' => string 'LSApplication' (length=13)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      15 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\guide-doc.php' (length=50)
          'line' => int 1
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
  private 'previous' (Exception) => null
  public 'xdebug_message' => string '<tr><th align='left' bgcolor='#f57900' colspan="5"><span style='background-color: #cc0000; color: #fce94f; font-size: x-large;'>( ! )</span> LogicException: Class LSContentsCookieUsage could not be loaded in D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php on line <i>3601</i></th></tr>
<tr><th align='left' bgcolor='#e9b96e' colspan='5'>Call Stack</th></tr>
<tr><th align='center' bgcolor='#eeeeec'>#</th><th align='left' bgcolor='#eeeeec'>Time</th><th align='left' bgcolor='#eeeeec'>Mem'... (length=6503)

Guide Documentation

Niouzes

Citation

Documentation of Guide

Introduction

File headers

Inner Guide tags

Example