diff options
| author | Kai Koehne <kai.koehne@qt.io> | 2017-09-14 10:34:09 +0200 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2017-09-18 07:12:47 +0000 |
| commit | ad18484063a41328d0e72c75cda151128977e0d8 (patch) | |
| tree | d3a8e14006ebddf9c47719475cc24135051bb86c /examples | |
| parent | fce8978426b9dbad8ea60412ba34d855a9c90a24 (diff) | |
Improve SimpleTextViewer example documentation
Change-Id: I6da730993b6e9a0fd3b75705547260aef638048d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/assistant/doc/src/simpletextviewer.qdoc | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/examples/assistant/doc/src/simpletextviewer.qdoc b/examples/assistant/doc/src/simpletextviewer.qdoc index 7afef1a78..4954fbfc5 100644 --- a/examples/assistant/doc/src/simpletextviewer.qdoc +++ b/examples/assistant/doc/src/simpletextviewer.qdoc @@ -34,15 +34,14 @@ \image simpletextviewer-example.png - This is done in two stages. Firstly, documentation is created and \QA - is customized; secondly, the functionality to launch and control - \QA is added to the application. + This example shows how to use \QA as a customized help viewer in + a custom application. This is done in two stages. Firstly, + documentation is created and \QA is customized; secondly, the + functionality to launch and control \QA is added to the application. The Simple Text Viewer application lets the user select and view - existing files. - - The application provides its own custom documentation that is - available from the \gui Help menu in the main window's menu bar + existing files. The application provides its own custom documentation + that is available from the \gui Help menu in the main window's menu bar or by clicking the \gui Help button in the application's find file dialog. @@ -353,8 +352,8 @@ The implementation for \c showDocumentation() is now straightforward. Firstly, we ensure that \QA is running, then we send the request to display the \a page via the \c stdin channel of the process. It is very - important here that the command is terminated by the '\\0' character - followed by an end of line token to flush the channel. + important here that the command is terminated by an end of line token + to flush the channel. \snippet simpletextviewer/assistant.cpp 1 |