phpdoc przyklad jak uzyc funkcji/metody Opcje

[marcio]

Elo mam dylemat chce sobie zaczac dokumentowac kod...juz mam wszystko zrobione...jednak mam pewne metody gdzie samo @access,@param,@return mi nie wystarcza chcialbym w zrodlo pliku w ktorym sie znajduje klasa podac maly przyklad uzycia metody.
Czy robi sie to za pomoca: http://manual.phpdoc.org/HTMLSmartyConvert...xample.pkg.html czy http://manual.phpdoc.org/HTMLSmartyConvert...source.pkg.html

Pytam bo nie jestem pewny...

[marcio]

Czyli to powinno byc poprawne:

[PHP] pobierz, plaintext 
	/**
	*Ustawia nam dla danej kolumny odpowiedni typ w html
	*@access public 
	*@param string $key nazwa pola
	*@param string $type
	*przyklad uzycia np kolumna news_author w $this -> db_fields_equivalent jest typu text chcemy ja zmienic na textarea
	*<code>
	*	<?php
	*		$instance -> set_equivalent('news_author', 'textarea');
	*	?>
	*</code>
	*/
	public function set_equivalent($field, $type) 
	{
		if(array_key_exists($field, $this -> db_fields_equivalent))
			$this -> db_fields_equivalent[$field] = $type;
	}
[PHP] pobierz, plaintext 

Pytam bo tak ogolnie to nie bede na srv mial phpdoc ale nigdy nie wiadomo a samemu mi to pomoze w przyszlosci ;]