Sorry for the long post, but trying to use phpDocumentor for the first time. Probably a really simple error but I have a class which I am trying to define comments.
Errors:@package not found.
Private items output.
Anyone see quickly why ?
Using .ini file with
Code: Select all
;; show elements marked @access private in documentation by setting this to on
;; legal values: on, off
parseprivate = off
;; what is the main package?
;; legal values: alphanumeric string plus - and _
defaultpackagename =CompanyNameSimplified code as follows
Code: Select all
<?php
/**
* Short file description.
*
* Long file description.
*
* @version 1.1
* @access public
* @package TopLevel
*/
/**
* Short Desc
*
* <p>Long Desc 1</p>
* <p>Long Desc 2</p>
*
* @subpackage Mysub
*/
class myClass
{
/**#@+
* @var array
* @access private
*/
var $array1;
var $array2;
/**#@-*/
/**#@+
* @var string
* @access private
*/
var $string1;
var $string2;
/**#@-*/
/**
* Constructor
*
* This constructor does xyz
*
* @param integer $x description of this param
* @param string $y description of this param
* @version 1.0
*/
function myClass ($x,$y) {
// Constructor Code
}
/**
* method1 ShortDesc
*
* method1 Long Desc
*
* @param string $var Description of this param
* @version 1.0
*/
function method1($var)
{
// Code Method 1
}
/**
* method2 ShortDesc
*
* method2 Long Desc
*
* @access private
* @param string $var Description of this param
* @version 1.0
*/
function method1($var)
{
// Code Method 1
}
}
?>Thanks for any help.