<?xml version="1.0"?>
<page id="Gimp.Procedure.set_documentation"
      type="topic"
      style="method"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="Gimp.Procedure" group="method" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>void</api:type>
      </api:returns>
      <api:name>gimp_procedure_set_documentation</api:name>
      <api:arg>
        <api:type>String</api:type>
        <api:name>blurb</api:name>
      </api:arg>
      <api:arg>
        <api:type>String</api:type>
        <api:name>help</api:name>
      </api:arg>
      <api:arg>
        <api:type>String</api:type>
        <api:name>help_id</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.Procedure.prototype.set_documentation</title>
  <synopsis><code mime="text/x-gjs">
function set_documentation(blurb: String, help: String, help_id: String): void {
    // Gjs wrapper for gimp_procedure_set_documentation()
}
  </code></synopsis>
  <p><code>blurb</code> is used as the <code>procedure</code>'s tooltip when represented in the UI,
for example as a menu entry.</p>  <p>For translations of tooltips to work properly, <code>blurb</code> should only
be marked for translation but passed to this function untranslated,
for example using N_("Blurb"). GIMP will look up the translation in
the textdomain registered for the plug-in.</p>  <p><code>help</code> is a free-form text that's meant as documentation for
developers of scripts and plug-ins.</p>  <p>Sets various documentation strings on <code>procedure</code>.</p>
  <p>Since 3.0</p>
<terms>
<item>
<title><code>blurb</code></title>
  <p>The <code>procedure</code>'s blurb.</p>
</item>
<item>
<title><code>help</code></title>
  <p>The <code>procedure</code>'s help text.</p>
</item>
<item>
<title><code>help_id</code></title>
  <p>The <code>procedure</code>'s help ID.</p>
</item>
</terms>

</page>
