How to add new function definition to use in tooltip (ctrl-q) and context menu ?

Hi and thank you for your great IDE !

I want to add some specific function declaration (PHP or Javascript) to use with the tip <ctrl-q> and object context menu, but I dont have acess to the function implementation.

I just have these function describe in a wiki.
I want to give phpStorm documentation for these function (according to context menu and <ctrl>-q and <ctrl>-p) and be able to share it with the other developers of the project who use phpStorm.

For example, for PHP, I create a class that extend

extends Table

and I only got, in a wiki, the list of functions available for the class Table.
I havent access to the full definition of class Table.

I can use functions like

self::DbQuery

or

$this->getUniqueValueFromDB

But phpStrom dont have access to the declaration of these functions (method not found).

Can I write my function declaration somewhere phpStorm can find it and propose me the list of methods usable for this object, and give me function documentation and parameters with <ctrl>-q, p?

I've got PHP and Javascript functions.

best regards.

 

0
1 comment

You're probably talking about BGA repository? Straightforward solution here would be to include the BGA repository in a project like it's done here, see BGAWorkbench folder, or src/BGAWorkbench/Stubs/module/table/table.game.php specifically. 

Another option would be to document methods using @method PHPDoc annotation, e.g.:

0

Please sign in to leave a comment.