Skip to content
This repository was archived by the owner on Oct 15, 2019. It is now read-only.

Commit

Permalink
Fix qch doc build
Browse files Browse the repository at this point in the history
This will allow the docs to show up in
Qt Creator and Assistant.
  • Loading branch information
gladhorn committed Jul 4, 2013
1 parent 6656270 commit 7ad052c
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 5 deletions.
28 changes: 28 additions & 0 deletions doc/enginio-qt.qdocconf
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,31 @@ exampledirs += \

depends += qtcore qtgui qtwidgets qtdoc qtdeclarative

qhp.projects = Enginio

qhp.Enginio.file = enginio-qt.qhp
qhp.Enginio.namespace = io.engin.$QT_VERSION
qhp.Enginio.virtualFolder = enginio
qhp.Enginio.indexTitle = Enginio Overview
qhp.Enginio.indexRoot =

qhp.Enginio.filterAttributes = enginio $QT_VERSION qtrefdoc
qhp.Enginio.customFilters.Qt.name = Enginio $QT_VERSION
qhp.Enginio.customFilters.Qt.filterAttributes = enginio $QT_VERSION

qhp.Enginio.subprojects = classes qmltypes examples

qhp.Enginio.subprojects.classes.title = C++ Classes
qhp.Enginio.subprojects.classes.indexTitle = Enginio C++ Classes
qhp.Enginio.subprojects.classes.selectors = class
qhp.Enginio.subprojects.classes.sortPages = true

qhp.Enginio.subprojects.qmltypes.title = QML Types
qhp.Enginio.subprojects.qmltypes.indexTitle = Enginio QML Types
qhp.Enginio.subprojects.qmltypes.selectors = fake:qmlclass
qhp.Enginio.subprojects.qmltypes.sortPages = true

qhp.Enginio.subprojects.examples.title = Examples
qhp.Enginio.subprojects.examples.indexTitle = Enginio Examples
qhp.Enginio.subprojects.examples.selectors = fake:example
qhp.Enginio.subprojects.examples.sortPages = true
28 changes: 23 additions & 5 deletions src/enginio_client/enginio.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ To get started quickly follow the mini-tutorial using Qt Quick or C++.

\section1 Reference documentation and examples:
\list
\li \l {All Enginio Classes}
\li \l {Enginio Classes and QML Types}
\li \l {Enginio Examples}
\endlist

Expand Down Expand Up @@ -278,7 +278,7 @@ Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashb
\title Checking stored objects in the Dashboard
\indexpage Enginio Overview
\previouspage Getting Started with Enginio using C++
\nextpage All Enginio Classes
\nextpage Enginio Classes and QML Types

When you have successfully stored objects with Qt C++ or QML code, go to your \l{https://dashboard.engin.io/}{Enginio Dashboard}
and check the status there.
Expand Down Expand Up @@ -307,8 +307,26 @@ To get convenient access to objects stored in Enginio, consider using \l Enginio
*/

/*!
\page classes.html
\title All Enginio Classes
\page enginio-classes.html
\title Enginio C++ Classes
\indexpage Enginio Overview

Enginio provides these \b{C++ classes}:
\generatelist {classesbymodule enginio-qt}
*/

/*!
\page enginio-qml-types.html
\title Enginio QML Types
\indexpage Enginio Overview

Enginio provides these \b{QML types}:
\annotatedlist engino-qml
*/

/*!
\page enginio-classes-and-types.html
\title Enginio Classes and QML Types
\indexpage Enginio Overview
\startpage Enginio Overview
\previouspage Checking stored objects in the Dashboard
Expand All @@ -329,7 +347,7 @@ Enginio provides these \b{QML types}:
\page enginio-examples.html
\indexpage Enginio Overview
\startpage Enginio Overview
\previouspage All Enginio Classes
\previouspage Enginio Classes and QML Types

\title Enginio Examples
\brief Using Enginio
Expand Down

0 comments on commit 7ad052c

Please sign in to comment.