Eclipse Community Forums: PHP Development Tools (PDT) » Custom ide-tooltip-popup for functions

Home » Language IDEs » PHP Development Tools (PDT) » Custom ide-tooltip-popup for functions

Custom ide-tooltip-popup for functions [message #46418]

Sun, 26 August 2007 02:39

Eclipse User

Hi,

I don't know how to find info about this: when I type the name of a php
function the ide show a tooltip popup with infoemations about the function
and its parameters, something like

-------------------------------------
Description
This function do this and this...

Parameters
usefulparam int

Returns
int
-------------------------------------

Can I write documentation on my custom functions so that when they are
written the ide shows the infos about them?
How?

I hope to be clear :)

Thanks

Re: Custom ide-tooltip-popup for functions [message #46477 is a reply to message #46418]

Sun, 26 August 2007 07:36

Eclipse User

Originally posted by: reply-to-newsgroup.news.com

The documentation of a PHP function is taken by parsing the standard PHPDoc
block that exists right above the function.
You can read about the PHPDoc at: http://www.phpdoc.org/
Shalom Gibly
Zend

"Fabio" <znt.fabio@virgilio.it> wrote in message
news:far7kb$2rn$1@build.eclipse.org...
> Hi,
>
> I don't know how to find info about this: when I type the name of a php
> function the ide show a tooltip popup with infoemations about the function
> and its parameters, something like
>
> -------------------------------------
> Description
> This function do this and this...
>
> Parameters
> usefulparam int
>
> Returns
> int
> -------------------------------------
>
> Can I write documentation on my custom functions so that when they are
> written the ide shows the infos about them?
> How?
>
> I hope to be clear :)
>
> Thanks
>

Re: Custom ide-tooltip-popup for functions [message #46502 is a reply to message #46477]

Sun, 26 August 2007 08:08

Eclipse User

"Shalom Gibly" <reply-to-newsgroup@news.com> ha scritto nel messaggio
news:farojd$tk6$1@build.eclipse.org...
> The documentation of a PHP function is taken by parsing the standard
> PHPDoc block that exists right above the function.
> You can read about the PHPDoc at: http://www.phpdoc.org/

Thank you, the syntax seems to be already supported by pdt.
The problem is that the tooltip is really small and it shows only a little
part of the description... :(

Re: Custom ide-tooltip-popup for functions [message #46529 is a reply to message #46502]

Sun, 26 August 2007 09:08

Eclipse User

"Fabio" <znt.fabio@virgilio.it> ha scritto nel messaggio
news:farqfm$11b$1@build.eclipse.org...

> Thank you, the syntax seems to be already supported by pdt.
> The problem is that the tooltip is really small and it shows only a little
> part of the description... :(

Another question.

I try with something like

<?php
class my_class {
/**
* Do a sum
* @param int $a
* @param int $b
* @return int
*/
function sum($a,$b){ return $a+$b; }
}
?>

When I type

$x = new my_class();
$x->

The tooltip says

-----------------------
Location:
/directory/file.php

Class:
my_class

Description:
Do a sum

Parameters:
int a
int b
....
-----------------------

It says the location and the class name that are not required, and then the
bottom is trunked so even the return type is listed :(

Previous Topic:	Zend Debugger+suhosin=encrypted cookies=no session debug
Next Topic:	How to find out debug_session_id?

Goto Forum:

-=] Back to Top [=-

Current Time: Sun Jul 13 22:15:32 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter