<?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>none</api:type>
      </api:returns>
      <api:name>gimp_procedure_set_documentation</api:name>
      <api:arg>
        <api:type>Gimp.Procedure</api:type>
        <api:name>self</api:name>
      </api:arg>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>blurb</api:name>
      </api:arg>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>help</api:name>
      </api:arg>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>help_id</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.Procedure.set_documentation</title>
  <synopsis><code mime="text/x-python">
@accepts(Gimp.Procedure, unicode, unicode, unicode)
@returns(none)
def set_documentation(self, blurb, help, help_id):
    # Python wrapper for gimp_procedure_set_documentation()
  </code></synopsis>
  <p>Sets various documentation strings on <code>self</code>:</p>  <p>* <code>blurb</code> is used for instance as the <code>self</code>'s tooltip when represented in
  the UI such as a menu entry.
* <code>help</code> is a free-form text that's meant as additional documentation for
  developers of scripts and plug-ins. If the <code>blurb</code> and the argument names
  and descriptions are enough for a quite self-explanatory procedure, you may
  set <code>help</code> to <code>None</code>, rather than setting an uninformative <code>help</code> (avoid
  setting the same text as <code>blurb</code> or redundant information).</p>  <p>Plug-ins are responsible for their own translations. You are expected to send
localized strings of <code>blurb</code> and <code>help</code> to GIMP if your plug-in is
internationalized.</p>
  <p>Since 3.0</p>
<terms>
<item>
<title><code>self</code></title>
  <p>A <link xref="Gimp.Procedure"/>.</p>
</item>
<item>
<title><code>blurb</code></title>
  <p>The <code>self</code>'s blurb.</p>
</item>
<item>
<title><code>help</code></title>
  <p>The <code>self</code>'s help text.</p>
</item>
<item>
<title><code>help_id</code></title>
  <p>The <code>self</code>'s help ID.</p>
</item>
</terms>

</page>
