Annotate designs | Qt Creator Documentation

- Qt Creator Documentation
- Annotate designs
- Qt Creator 19.0.1

Add assets ◦ Convert UI projects to applications

# Annotate 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.

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

## Annotate components

To add annotations to components:

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

   Selected component shows the ID of the component.

3. In Name, enter a free-form text that describes the component.
4. In Title, enter the text to display in the tab for this comment.
5. In Author, enter the author's name.
6. In Text, enter the comment text.
7. Select OK.

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

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

To view the annotations in table format, select Table view.

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

## Add global annotations

To add or edit global annotations:

- Select on the top toolbar.
- Go to Edit and select Edit Global Annotations.

Global annotations have an additional status property for indicating 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.

See also How to: Design Qt Quick UIs, Qt Quick UI design, and Designing Qt Quick UIs.

Add assets ◦ Convert UI projects to applications