Documenting a service

A service can be documented using comments. Aside from service-level comments, comments can also be added to individual Gloop steps.

Commenting on a service

To add comments to a service:

1. Open the Properties view by clicking on any blank space on the step tree or by clicking the table-shaped icon in the toolbar.
2. Click on the Comments tab.
3. Type your comment.

Also used in documenting Gloop API endpoints

A service-level comment will automatically be used to document the API where the service is used when it is exposed via a Gloop REST or SOAP API.

Commenting on steps

Adding comments to individual steps is similar:

1. Select a step.
2. Open the Properties view by clicking the table-shaped icon in the toolbar, if it isn't open yet.
3. Click on the Comments tab.
4. Type your comment.

Use the shortcut to quickly edit step comments

You can also edit step comments by selecting the step and pressing the key, like so:

Step comments are displayed next to the step in gray prefixed with // when short, or surrounded with /* ... */ when long. Long comments will not show entirely but when hovering over a step, they will appear as a tooltip.