Annotating Designs

You can submit your designs to review or further development as QML files. You can annotate your designs to provide reviewers or developers with additional information about them. An annotation consist of an annotation name and one or several comments. The comments have a title, author, and comment text.

"Annotations displayed in the Form Editor view"

Annotations are saved in the end of QML files when you save the file. They do not affect the QML performance in any way.

To view annotations, select the annotation icon.

To edit annotations, select Edit Annotation in the context menu of the annotation icon.

Adding Annotations

To add annotations:

  1. Select the component to annotate in the Navigator or in the Form Editor.
  2. In the Properties view, select Add Annotation.

    "Annotation Editor"

  3. The Selected Item field displays the ID of the component. Enter a name for the annotation in the Custom ID field.
  4. In the Title field, enter the text to display in the tab for this comment.
  5. In the Author field, enter the author's name.
  6. In the Text field, enter the comment text.
  7. Select OK.

To add more comments about the component, select the (Add Comment) button.

To remove the active comment, select the (Remove Comment) button. To remove the annotation, right-click the annotation icon, and then select Remove Annotation.

Available under certain Qt licenses.
Find out more.