This page has no translation to Русский yet. The original English version is below. If you’d like to help, great! See how to translate a documentation page in the contribution guide.
Note This is a web-version of a tutorial chapter embedded right into the XOD IDE. To get a better learning experience we recommend to install the desktop IDE or start the browser-based IDE, and you’ll see the same tutorial there.

Adding Documentation

Screenshot of 305-document-it

The only thing our node lacks is proper documentation. The pins are unlabeled and the help panel does not describe what it does at all. Let’s fix that.

Instructions #

Apply the instructions to your between node.

  1. Using Inspector add descriptions to the terminal nodes. They will become pin descriptions in the help panel.
  2. Click on any empty space on the patch to see the Inspector for the whole patch.
  3. Add the description for the whole patch. It will become the node’s description for the node in the help panel.
  4. Invoke the help box to see how the documentation renders.
Found a typo or mistake? Want to improve the text? Edit this page on GitHub and open a pull request. If you have a complex proposal or you want to discuss the content, feel free to start a new thread on XOD forum.