Creator's Guide

Creator's Guide

My patching files generally comply to the Geany mannual except some tweaks in the tags files.

Tags file

As explained in the mannual, each entry of the tag file:

basename|string|(string path [, string suffix])|

The first field is the tag name (usually a function name).
The second field is the type of the return value.
The third field is the argument list for this tag.
The fourth field is the description for this tag but currently unused and should be left empty.

I have come up with my own convention (or tweak) to show extra info of the JS functions:

function_name | [(library_name)] [[static]] [attached_symbol.] | ([param1[: Type1][, ..., paramN[: TypeN]]])[: Return_Type] |

Basically, the first field is still the property or function name.
The second field comprises of: name of the library (e.g. Mootools), static or not, and lastly, the Class that function is attached to.
The third field contains optional parameters with/without type and the function returned type. The ": Type" notation is borrowed from ActionScript. If you leave this field empty, the symbol is considered property, not function, and it has different color in the hinting list.

For example:

slice|Array.|(begin: number[, end: number]): Array|

The hint popup will show like this:

Array. slice (begin: number[, end: number]): Array

And setProperty|(Mootools 1.4) Element.|(name, value)| will be output as:

(Mootools 1.4) Element. setProperty (name, value)

That is the best notation format I can think of for the function hint with current limitations of Geany. For property names, there's no way to show extra info of them exept the name.

When Geany is improved and can handle tags better, I will revise and adapt this convention.