Search from documentation | Qt Creator Documentation

- Qt Creator Documentation
- Search from documentation
- Qt Creator 17.0.1

How To

# Search from documentation

In the Help mode Search pane, use full-text search for finding a particular word in all the installed documents. Enter the term you are looking for, and select Search. All documents that have the specified term are listed. The list is sorted by document version (if you have installed several Qt versions, for example) and the number of search hits that the documents have. Select a document in the list to open it.

The following are examples of common search patterns:

- `deep` lists all the documents that have the word `deep`. The search is not case sensitive.
- `deep*` lists all the documents that have a word beginning with `deep`
- `deep copy` lists all documents that have both `deep` and `copy`
- `"deep copy"` lists all documents that have the phrase `deep copy`

Full-text search is based on indexing all the installed documents the first time when you open the Search pane. If you add or remove documents, Qt Creator recreates the index.

If you cannot find words that you know are there, the index might not be complete. To recreate it, select (Regenerate Index).

Punctuation is not included in indexed terms. To find terms that have punctuation, such as domain names, use the asterisk as a wild card. For example, to find `Pastebin.Com`, enter the search term `Pastebin*`.

See also How To: Read Documentation.

How To