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.
{{{*fheader … *}}}
{*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.
/**************************************************************************/ /** {{{*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 *} *} *}}} */ /**************************************************************************/