Gimp.Procedure.prototype.set_documentation

function set_documentation(blurb: String, help: String, help_id: String): void {
    // Gjs wrapper for gimp_procedure_set_documentation()
}
  

Sets various documentation strings on procedure:

* blurb is used for instance as the procedure's tooltip when represented in the UI such as a menu entry. * help is a free-form text that's meant as additional documentation for developers of scripts and plug-ins. If the blurb and the argument names and descriptions are enough for a quite self-explanatory procedure, you may set help to null, rather than setting an uninformative help (avoid setting the same text as blurb or redundant information).

Plug-ins are responsible for their own translations. You are expected to send localized strings of blurb and help to GIMP if your plug-in is internationalized.

Since 3.0

blurb

The procedure's blurb.

help

The procedure's help text.

help_id

The procedure's help ID.