diff options
Diffstat (limited to 'src/assistant/assistant/doc')
7 files changed, 76 insertions, 25 deletions
diff --git a/src/assistant/assistant/doc/qtassistant.qdocconf b/src/assistant/assistant/doc/qtassistant.qdocconf index 6c130d7f6..76e65903d 100644 --- a/src/assistant/assistant/doc/qtassistant.qdocconf +++ b/src/assistant/assistant/doc/qtassistant.qdocconf @@ -1,33 +1,33 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -project = qtassistant +project = QtAssistant description = Qt Assistant Manual url = http://qt-project.org/doc/qtassistant -qhp.projects = Assistant - -qhp.Assistant.file = qtassistant.qhp -qhp.Assistant.namespace = org.qt-project.assistant.500 -qhp.Assistant.virtualFolder = assistant -qhp.Assistant.indexTitle = Qt Assistant Manual - -qhp.Assistant.filterAttributes = qt 5.0.0 tools assistant -qhp.Assistant.customFilters.Assistant.name = Qt Assistant Manual -qhp.Assistant.customFilters.Assistant.filterAttributes = qt tools assistant -qhp.Assistant.subprojects = manual examples -qhp.Assistant.subprojects.manual.title = Manual -qhp.Assistant.subprojects.manual.indexTitle = Qt Assistant Manual -qhp.Assistant.subprojects.manual.selectors = fake:page -qhp.Assistant.subprojects.examples.title = Examples -qhp.Assistant.subprojects.examples.indexTitle = Qt Examples -qhp.Assistant.subprojects.examples.selectors = fake:example -qhp.Assistant.subprojects.examples.sortPages = true +qhp.projects = QtAssistant + +qhp.QtAssistant.file = qtassistant.qhp +qhp.QtAssistant.namespace = org.qt-project.assistant.500 +qhp.QtAssistant.virtualFolder = assistant +qhp.QtAssistant.indexTitle = Qt Assistant Manual + +qhp.QtAssistant.filterAttributes = qt 5.0.1 tools assistant +qhp.QtAssistant.customFilters.QtAssistant.name = Qt Assistant Manual +qhp.QtAssistant.customFilters.QtAssistant.filterAttributes = qt tools assistant +qhp.QtAssistant.subprojects = manual examples +qhp.QtAssistant.subprojects.manual.title = Manual +qhp.QtAssistant.subprojects.manual.indexTitle = Qt Assistant Manual +qhp.QtAssistant.subprojects.manual.selectors = fake:page +qhp.QtAssistant.subprojects.examples.title = Examples +qhp.QtAssistant.subprojects.examples.indexTitle = Qt Assistant Examples +qhp.QtAssistant.subprojects.examples.selectors = fake:example +qhp.QtAssistant.subprojects.examples.sortPages = true language = Cpp sourcedirs = .. -exampledirs = ../../../../examples \ +exampledirs = ../../../../examples/assistant \ snippets imagedirs = images diff --git a/src/assistant/assistant/doc/snippets/doc_src_assistant-manual.qdoc b/src/assistant/assistant/doc/snippets/doc_src_assistant-manual.qdoc index 730373cd3..beb17059b 100644 --- a/src/assistant/assistant/doc/snippets/doc_src_assistant-manual.qdoc +++ b/src/assistant/assistant/doc/snippets/doc_src_assistant-manual.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. diff --git a/src/assistant/assistant/doc/snippets/simpletextviewer/assistant.cpp b/src/assistant/assistant/doc/snippets/simpletextviewer/assistant.cpp index 57588f837..f379717eb 100644 --- a/src/assistant/assistant/doc/snippets/simpletextviewer/assistant.cpp +++ b/src/assistant/assistant/doc/snippets/simpletextviewer/assistant.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the examples of the Qt Toolkit. diff --git a/src/assistant/assistant/doc/snippets/simpletextviewer/findfiledialog.cpp b/src/assistant/assistant/doc/snippets/simpletextviewer/findfiledialog.cpp index e423c1308..a1c96607b 100644 --- a/src/assistant/assistant/doc/snippets/simpletextviewer/findfiledialog.cpp +++ b/src/assistant/assistant/doc/snippets/simpletextviewer/findfiledialog.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the examples of the Qt Toolkit. diff --git a/src/assistant/assistant/doc/snippets/simpletextviewer/mainwindow.cpp b/src/assistant/assistant/doc/snippets/simpletextviewer/mainwindow.cpp index c4609153f..1f0b79f74 100644 --- a/src/assistant/assistant/doc/snippets/simpletextviewer/mainwindow.cpp +++ b/src/assistant/assistant/doc/snippets/simpletextviewer/mainwindow.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the examples of the Qt Toolkit. diff --git a/src/assistant/assistant/doc/src/assistant-example.qdoc b/src/assistant/assistant/doc/src/assistant-example.qdoc new file mode 100644 index 000000000..0ed7e6737 --- /dev/null +++ b/src/assistant/assistant/doc/src/assistant-example.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \group examples-qtassistant + \ingroup all-examples + \title Qt Assistant Examples + \brief Using Qt Assistant as a help viewer for Qt applications. + + \image assistant-examples.png + + Qt Assistant provides support for interactive help and enables you to + display customer documentation to users of your Qt applications. + + The following examples illustrate how to use Qt Assistant as a help viewer + for applications. + +*/ + +/* + \list + \li \l{simpletextviewer}{Simple Text Viewer}\raisedaster + \li \l{remotecontrol}{Remote Control} + \endlist + + Examples marked with an asterisk (*) are fully documented. +*/ diff --git a/src/assistant/assistant/doc/src/assistant-manual.qdoc b/src/assistant/assistant/doc/src/assistant-manual.qdoc index a96a4b4bb..aa426ee2f 100644 --- a/src/assistant/assistant/doc/src/assistant-manual.qdoc +++ b/src/assistant/assistant/doc/src/assistant-manual.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. |