phpDOC Question

[darksniperx]

Dont know if I am in the right section, But I am trying to use phpDoc to generate documents. And phpdoc ignores my code.

 

<?php
  /**
   * Location Support Page
   *
   * Form that allows users to bypass validation
   * @author Dev Team <devteam@devteam>
   * @version $Id: byPass.php,v 1.0 2008/03/13 13:38:27 cellog Exp $;
   * @package byPass
   */
  
  /**
   * Stores search results.
   * @var string
   * @name $result
   */
  $result = '';
  
  /**
   * @var string
   * @internal Stores sql connection for server A
   */
  $connection = mysql_connect();

?>

 

OUTPUT:

 

Description:

 

Location Support Page

 

 

Form that allows users to bypass validation

 

 

author: Dev Team <devteam@devteam>

version: $Id: byPass.php,v 1.0 2008/03/13 13:38:27 cellog Exp $;

 

 

php doc ignores all of my @var,@internal,@name,.. tags. Any ideas?

 

 

[soycharliente]

Because you commented it out.

[darksniperx]

what would be the proper way of writing phpDocumentations.?

[digitalgod]

there's an entire section dedicated to tutorials for phpDoc on their site, it can be found here http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html

[darksniperx]

I am allready using that site and I am folowing their examples, but cant figure out where is the problem.

[roopurt18]

Because you commented it out.

Doc tags go in comments

 

 

I would say the problem is not in how you're writing your doc tags but how you are generating them.  I don't really have much experience generating doc tags but make sure you are using the program that generates them correctly and setting all of the proper flags.  Other than that maybe someone will have something more for you.