Hi,
first of all many thanks for this great IDE. You make my day; everyday
I have searched the forum but I haven't found any help for my question and I have tried a lot of different things, but without luck.
Let us have a look on an example function:
Code:
/**
* Resets a password
*
* @param int User ID
* @param int Should an eMail be sent to User?
*
* @return int Password reset done
*/
function resetPassWord (, =false)
{
...
return;
}
resetPassWord();
If the mouse pointer is hovering over the function resetPassWord(), a tooltip is shown like this:
Quote:
int resetPassWord (int $userID, int $sendEMail)
Description
Resets a password
Parameters:
int $userID User ID
int $sendEMail Should an eMail be sent to User?
Return:
$isDone Password reset done
This is great and helps me a lot, but something is missing. At the tooltip above, you can't see, that parameter $sendEMail is optional.
Of course I can add this fact to the param comment. But:
If one is e.g. hovering over the PHP function sprintf -> the tooltip is showing everything above but additionally two blocks starting with Definition and Version.
Within the block Definition one can see, that mixed $args is optional.
I have added an PDF as attachement, where you can see it as snipping pictures!
What is the trick behind, to have this Definition block also with my functions.
I have tried all @... Parameters I have found in the world wide web (also PHPdoc) but it seems, I have not found the right one or it is not working by design.
Can you help?
Thanks a lot and kind regards
Robert
Login
Register
FAQ
Search
