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. You can add global annotations that apply to the whole file or annotate individual components.

An annotation consist of an annotation name and one or several comments. The comments have a title, author, and comment text.

To add or edit global annotations, select on the top menu bar in the Design mode.

Global annotations have an additional status property, which enables you to indicate whether you are still working on the design, you have submitted it to review, or it can be considered done. To set the status, select Add Status.

"Annotation Editor"

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

Annotating Components

To add annotations to components:

  1. Select the component to annotate in Navigator or in Form Editor.
  2. In Properties, 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.

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

Available under certain Qt licenses.
Find out more.