set_documentation


Description:

[ Version ( since = "3.0" ) ]
public void set_documentation (string blurb, string? help, string? help_id)

Sets various documentation strings on this:

* blurb is used for instance as the this'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.

Parameters:

this

A Procedure.

blurb

The this's blurb.

help

The this's help text.

help_id

The this's help ID.