Sample documented script and ThimbleDoc syntax
Source PHP file
<?php
/**
* Description of sample file
* @author thimbleopensource.com
* @package ThimbleDoc
* @version 0.2
*/
/// This class is only for demonstration how ThimbleDoc
/// documentator works.
class SampleClass {
private $variable1;
public $variable2;
/// Documentation for SampleFunction
/// @var $var1 Variable description
/// @return Boolean
function SampleFunction($var1, &$var2, $var3 = 'val') {
return true;
}
}
?>
Resulting documentation from above code
Sample documented file
Description of sample file
Author: thimbleopensource.com
Package: ThimbleDoc
Version: 0.2
Class SampleClass
This class is only for demonstration how ThimbleDoc
documentator works.
Variables
- private $variable1
- public $variable2
Function SampleFunction
Documentation for SampleFunction
Arguments
- $var1
- &$var2
- $var3 = 'default value'
Return
Boolean