diff options
author | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-06-20 13:50:20 +0300 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-06-24 08:05:53 +0300 |
commit | 08997a9afdd8681d3bb28e99f1c8be4c4b47282c (patch) | |
tree | b05ba0cf8a201e3b1f51488ced4aa95fa5568651 | |
parent | e404fa6a329858520f19b4aa14be9bac2917b5fb (diff) |
Doc fixes and some cleanup
- Now generates enum documentation (not all values documented, though)
- Renamed the qdatavis3namespace.h as it was missing a 'd'
- Fixes a couple of warnings about deprecated QString constructor
Change-Id: Ib8698d8f6d9f5dd37682b71150dbc5731b6dedb4
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
24 files changed, 195 insertions, 145 deletions
diff --git a/src/datavis3d/doc/qtdatavis3d.qdocconf b/src/datavis3d/doc/qtdatavis3d.qdocconf index c3fd9826..0e9f6d5b 100644 --- a/src/datavis3d/doc/qtdatavis3d.qdocconf +++ b/src/datavis3d/doc/qtdatavis3d.qdocconf @@ -15,7 +15,7 @@ sourcedirs += .. depends += qtcore \ qtgui -qhp.projects = QtDataVis3D +qhp.projects = qtdatavis3d qhp.qtdatavis3d.file = qtdatavis3d.qhp qhp.qtdatavis3d.namespace = org.qt-project.qtdatavis3d.1.0.0 diff --git a/src/datavis3d/engine/bars3dcontroller_p.h b/src/datavis3d/engine/bars3dcontroller_p.h index 55ef1289..7dbce663 100644 --- a/src/datavis3d/engine/bars3dcontroller_p.h +++ b/src/datavis3d/engine/bars3dcontroller_p.h @@ -56,7 +56,7 @@ #include <QtCore/QObject> #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "bars3drenderer_p.h" //#define DISPLAY_RENDER_SPEED diff --git a/src/datavis3d/engine/bars3drenderer_p.h b/src/datavis3d/engine/bars3drenderer_p.h index ade9f7e6..6886d1c0 100644 --- a/src/datavis3d/engine/bars3drenderer_p.h +++ b/src/datavis3d/engine/bars3drenderer_p.h @@ -53,8 +53,7 @@ #define Q3DBARSRENDERER_p_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" - +#include "qdatavis3dnamespace.h" #include <QtCore/QSize> #include <QtCore/QObject> #include <QtGui/QOpenGLFunctions> diff --git a/src/datavis3d/engine/drawer.cpp b/src/datavis3d/engine/drawer.cpp index c7bef8ee..3fdaa58b 100644 --- a/src/datavis3d/engine/drawer.cpp +++ b/src/datavis3d/engine/drawer.cpp @@ -39,7 +39,7 @@ ** ****************************************************************************/ -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "drawer_p.h" #include "shaderhelper_p.h" #include "objecthelper_p.h" diff --git a/src/datavis3d/engine/drawer_p.h b/src/datavis3d/engine/drawer_p.h index 2dcafe2c..0b14ba3f 100644 --- a/src/datavis3d/engine/drawer_p.h +++ b/src/datavis3d/engine/drawer_p.h @@ -53,7 +53,7 @@ #define DRAWER_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dbars.h" #include "theme_p.h" #include "labelitem_p.h" diff --git a/src/datavis3d/engine/maps3dcontroller_p.h b/src/datavis3d/engine/maps3dcontroller_p.h index 1716b7cd..b0026a9b 100644 --- a/src/datavis3d/engine/maps3dcontroller_p.h +++ b/src/datavis3d/engine/maps3dcontroller_p.h @@ -53,7 +53,7 @@ #define MAPS3DCONTROLLER_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dmaps.h" #include <QOpenGLFunctions> diff --git a/src/datavis3d/engine/maps3drenderer_p.h b/src/datavis3d/engine/maps3drenderer_p.h index 13da3ff7..f90c198e 100644 --- a/src/datavis3d/engine/maps3drenderer_p.h +++ b/src/datavis3d/engine/maps3drenderer_p.h @@ -53,7 +53,7 @@ #define MAPS3DRENDERER_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include <QOpenGLFunctions> QT_DATAVIS3D_BEGIN_NAMESPACE diff --git a/src/datavis3d/engine/q3dbars.cpp b/src/datavis3d/engine/q3dbars.cpp index b81a5c71..189525b2 100644 --- a/src/datavis3d/engine/q3dbars.cpp +++ b/src/datavis3d/engine/q3dbars.cpp @@ -99,127 +99,6 @@ QT_DATAVIS3D_BEGIN_NAMESPACE */ /*! - \enum BarStyle - - Predefined bar types. - - \value Bars - Basic cubic bar. - \value Pyramids - Four -sided pyramid. - \value Cones - Basic cone. - \value Cylinders - Basic cylinder. - \value BevelBars - Slilghtly beveled (rounded) cubic bar. - \value Spheres - Sphere. Not usable in Q3DBars. -*/ - -/*! - \enum CameraPreset - - Predefined positions for camera. - - \value PresetFrontLow - \value PresetFront - \value PresetFrontHigh - \value PresetLeftLow - \value PresetLeft - \value PresetLeftHigh - \value PresetRightLow - \value PresetRight - \value PresetRightHigh - \value PresetBehindLow - \value PresetBehind - \value PresetBehindHigh - \value PresetIsometricLeft - \value PresetIsometricLeftHigh - \value PresetIsometricRight - \value PresetIsometricRightHigh - \value PresetDirectlyAbove - \value PresetDirectlyAboveCW45 - \value PresetDirectlyAboveCCW45 - \value PresetFrontBelow - From PresetFrontBelow onward these only work for graphs including negative values. - They act as Preset...Low for positive-only values. - \value PresetLeftBelow - \value PresetRightBelow - \value PresetBehindBelow - \value PresetDirectlyBelow - Acts as PresetFrontLow for positive -only bars. -*/ - -/*! - \enum ColorTheme - - Predefined color themes. - - \value ThemeSystem - \value ThemeBlueCerulean - \value ThemeBlueIcy - \value ThemeBlueNcs - \value ThemeBrownSand - \value ThemeDark - \value ThemeHighContrast - \value ThemeLight -*/ - -/*! - \enum SelectionMode - - Bar selection modes. - - \value ModeNone - Selection mode disabled. - \value ModeBar - Selection selects a single bar. - \value ModeBarAndRow - Selection selects a single bar and highlights the row it is on. - \value ModeBarAndColumn - Selection selects a single bar and highlights the column it is on. - \value ModeBarRowAndColumn - Selection selects a single bar and highlights the row and the column it is on. - \value ModeZoomRow - Selection selects a single bar and displays the row it is on in a separate view. The - original view is shrunk into upper left corner. Original view is restored by clicking - on it. - \value ModeZoomColumn - Selection selects a single bar and displays the column it is on in a separate view. The - original view is shrunk into upper left corner. Original view is restored by clicking - on it. -*/ - -/*! - \enum ShadowQuality - - Quality of shadows. - - \value ShadowNone - Shadows are disabled. - \value ShadowLow - Shadows are rendered in low quality. - \value ShadowMedium - Shadows are rendered in medium quality. - \value ShadowHigh - Shadows are rendered in high quality. -*/ - -/*! - \enum LabelTransparency - - Label transparencies. - - \value TransparencyNone - Full solid, using colors from theme. - \value TransparencyFromTheme - Use colors and transparencies from theme. - \value TransparencyNoBackground - Draw just text on transparent background. -*/ - -/*! * Constructs a new 3D bar window. */ Q3DBars::Q3DBars() diff --git a/src/datavis3d/engine/q3dbars.h b/src/datavis3d/engine/q3dbars.h index cb9cd5e5..ec52339a 100644 --- a/src/datavis3d/engine/q3dbars.h +++ b/src/datavis3d/engine/q3dbars.h @@ -43,7 +43,7 @@ #define Q3DBARS_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dwindow.h" #include <QFont> diff --git a/src/datavis3d/engine/q3dbars_p.h b/src/datavis3d/engine/q3dbars_p.h index 1e818813..26cfb712 100644 --- a/src/datavis3d/engine/q3dbars_p.h +++ b/src/datavis3d/engine/q3dbars_p.h @@ -53,7 +53,7 @@ #define Q3DBARS_p_H #include "bars3dcontroller_p.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" QT_DATAVIS3D_BEGIN_NAMESPACE diff --git a/src/datavis3d/engine/q3dmaps.h b/src/datavis3d/engine/q3dmaps.h index 439f2667..3041f30f 100644 --- a/src/datavis3d/engine/q3dmaps.h +++ b/src/datavis3d/engine/q3dmaps.h @@ -43,7 +43,7 @@ #define Q3DMAPS_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dwindow.h" #include <QFont> diff --git a/src/datavis3d/engine/q3dmaps_p.h b/src/datavis3d/engine/q3dmaps_p.h index 4f311342..f62058e8 100644 --- a/src/datavis3d/engine/q3dmaps_p.h +++ b/src/datavis3d/engine/q3dmaps_p.h @@ -53,7 +53,7 @@ #define Q3DMAPS_P_H #include "maps3dcontroller_p.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" QT_DATAVIS3D_BEGIN_NAMESPACE diff --git a/src/datavis3d/engine/q3dwindow.cpp b/src/datavis3d/engine/q3dwindow.cpp index 8af57dce..0cd5e515 100644 --- a/src/datavis3d/engine/q3dwindow.cpp +++ b/src/datavis3d/engine/q3dwindow.cpp @@ -116,7 +116,7 @@ void Q3DWindow::initialize() qDebug() << "GLSL version:" << (const char *)version; #if !defined(QT_OPENGL_ES_2) // If we have real OpenGL, GLSL version must be 1.2 or over. Quit if not. - QStringList splitversionstr = QString((const char *)version).split(" "); + QStringList splitversionstr = QString::fromLatin1((const char *)version).split(QChar::fromLatin1(' ')); if (splitversionstr[0].toFloat() < 1.2) qFatal("GLSL version must be 1.20 or higher. Try installing latest display drivers."); #endif diff --git a/src/datavis3d/engine/theme_p.h b/src/datavis3d/engine/theme_p.h index 58e38594..dbb01e3e 100644 --- a/src/datavis3d/engine/theme_p.h +++ b/src/datavis3d/engine/theme_p.h @@ -53,7 +53,7 @@ #define THEME_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dbars.h" class QColor; diff --git a/src/datavis3d/global/global.pri b/src/datavis3d/global/global.pri index 56cb9f8f..725bfd5f 100644 --- a/src/datavis3d/global/global.pri +++ b/src/datavis3d/global/global.pri @@ -2,4 +2,4 @@ INCLUDEPATH += $$PWD VPATH += $$PWD HEADERS += \ global/qdatavis3dglobal.h \ - global/qdatavis3namespace.h + global/qdatavis3dnamespace.h diff --git a/src/datavis3d/global/qdatavis3namespace.h b/src/datavis3d/global/qdatavis3dnamespace.h index 5aeb9464..a944fd53 100644 --- a/src/datavis3d/global/qdatavis3namespace.h +++ b/src/datavis3d/global/qdatavis3dnamespace.h @@ -46,7 +46,7 @@ #include <QOpenGLFunctions> #include <QVector3D> -QT_DATAVIS3D_BEGIN_NAMESPACE +namespace QtDataVis3D { // Constants used in several files // Compensation for z position; move all objects to positive z, as shader can't handle negative values correctly @@ -141,6 +141,6 @@ enum LabelTransparency { TransparencyNoBackground // Draw just text on transparent background }; -QT_DATAVIS3D_END_NAMESPACE +} #endif diff --git a/src/datavis3d/global/qtdatavis3dnamespace.qdoc b/src/datavis3d/global/qtdatavis3dnamespace.qdoc new file mode 100644 index 00000000..2c3fea3d --- /dev/null +++ b/src/datavis3d/global/qtdatavis3dnamespace.qdoc @@ -0,0 +1,172 @@ +/**************************************************************************** +** +** 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 QtDataVis3D module. +** +** $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$ +** +****************************************************************************/ + +/*! + \namespace QtDataVis3D + \inmodule QtDataVis3D + \target QtDataVis3D Namespace + + \brief The QtDataVis3D namespace contains miscellaneous identifiers + used throughout the QtDataVis3D library. +*/ + +/*! + \enum QtDataVis3D::BarStyle + + Predefined bar types. + + \value Bars + Basic cubic bar. + \value Pyramids + Four -sided pyramid. + \value Cones + Basic cone. + \value Cylinders + Basic cylinder. + \value BevelBars + Slilghtly beveled (rounded) cubic bar. + \value Spheres + Sphere. Not usable in Q3DBars. +*/ + +/*! + \enum QtDataVis3D::CameraPreset + + Predefined positions for camera. + + \value PresetFrontLow + \value PresetFront + \value PresetFrontHigh + \value PresetLeftLow + \value PresetLeft + \value PresetLeftHigh + \value PresetRightLow + \value PresetRight + \value PresetRightHigh + \value PresetBehindLow + \value PresetBehind + \value PresetBehindHigh + \value PresetIsometricLeft + \value PresetIsometricLeftHigh + \value PresetIsometricRight + \value PresetIsometricRightHigh + \value PresetDirectlyAbove + \value PresetDirectlyAboveCW45 + \value PresetDirectlyAboveCCW45 + \value PresetFrontBelow + From PresetFrontBelow onward these only work for graphs including negative values. + They act as Preset...Low for positive-only values. + \value PresetLeftBelow + \value PresetRightBelow + \value PresetBehindBelow + \value PresetDirectlyBelow + Acts as PresetFrontLow for positive -only bars. +*/ + +/*! + \enum QtDataVis3D::ColorTheme + + Predefined color themes. + + \value ThemeSystem + \value ThemeBlueCerulean + \value ThemeBlueIcy + \value ThemeBlueNcs + \value ThemeBrownSand + \value ThemeDark + \value ThemeHighContrast + \value ThemeLight +*/ + +/*! + \enum QtDataVis3D::LabelPosition + + Predefined positions for labels. + + \value LabelBelow + \value LabelLow + \value LabelMid + \value LabelHigh + \value LabelOver + \value LabelBottom + \value LabelTop + \value LabelLeft + \value LabelRight +*/ + +/*! + \enum QtDataVis3D::SelectionMode + + Bar selection modes. + + \value ModeNone + Selection mode disabled. + \value ModeBar + Selection selects a single bar. + \value ModeBarAndRow + Selection selects a single bar and highlights the row it is on. + \value ModeBarAndColumn + Selection selects a single bar and highlights the column it is on. + \value ModeBarRowAndColumn + Selection selects a single bar and highlights the row and the column it is on. + \value ModeZoomRow + Selection selects a single bar and displays the row it is on in a separate view. The + original view is shrunk into upper left corner. Original view is restored by clicking + on it. + \value ModeZoomColumn + Selection selects a single bar and displays the column it is on in a separate view. The + original view is shrunk into upper left corner. Original view is restored by clicking + on it. +*/ + +/*! + \enum QtDataVis3D::ShadowQuality + + Quality of shadows. + + \value ShadowNone + Shadows are disabled. + \value ShadowLow + Shadows are rendered in low quality. + \value ShadowMedium + Shadows are rendered in medium quality. + \value ShadowHigh + Shadows are rendered in high quality. +*/ + +/*! + \enum QtDataVis3D::LabelTransparency + + Label transparencies. + + \value TransparencyNone + Full solid, using colors from theme. + \value TransparencyFromTheme + Use colors and transparencies from theme. + \value TransparencyNoBackground + Draw just text on transparent background. +*/ diff --git a/src/datavis3d/utils/camerahelper_p.h b/src/datavis3d/utils/camerahelper_p.h index 365e0caa..a7df1288 100644 --- a/src/datavis3d/utils/camerahelper_p.h +++ b/src/datavis3d/utils/camerahelper_p.h @@ -53,7 +53,7 @@ #define CAMERAPOSITIONER_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dbars.h" #include <QObject> diff --git a/src/datavis3d/utils/utils_p.h b/src/datavis3d/utils/utils_p.h index 722523ac..be76f71c 100644 --- a/src/datavis3d/utils/utils_p.h +++ b/src/datavis3d/utils/utils_p.h @@ -53,7 +53,7 @@ #define UTILS_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "q3dbars.h" class QVector3D; diff --git a/src/datavis3dqml2/datavis3dqml2_plugin.h b/src/datavis3dqml2/datavis3dqml2_plugin.h index cc9cd6d7..c60f17f4 100644 --- a/src/datavis3dqml2/datavis3dqml2_plugin.h +++ b/src/datavis3dqml2/datavis3dqml2_plugin.h @@ -43,7 +43,7 @@ #define DATAVIS3DQML2_PLUGIN_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "qdataitem.h" #include "qdatarow.h" #include "qdataset.h" diff --git a/src/datavis3dqml2/declarativebars.h b/src/datavis3dqml2/declarativebars.h index eab3e24e..a416ea3e 100644 --- a/src/datavis3dqml2/declarativebars.h +++ b/src/datavis3dqml2/declarativebars.h @@ -44,7 +44,7 @@ #include "bars3dcontroller_p.h" #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "declarativebars_p.h" #include <qsgsimpletexturenode.h> diff --git a/src/datavis3dqml2/declarativebars_p.h b/src/datavis3dqml2/declarativebars_p.h index f96eb460..d4354324 100644 --- a/src/datavis3dqml2/declarativebars_p.h +++ b/src/datavis3dqml2/declarativebars_p.h @@ -53,7 +53,7 @@ #define DECLARATIVEBARS_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include <QString> QT_DATAVIS3D_BEGIN_NAMESPACE diff --git a/src/datavis3dqml2/declarativemaps.h b/src/datavis3dqml2/declarativemaps.h index 282fe168..69e3cee6 100644 --- a/src/datavis3dqml2/declarativemaps.h +++ b/src/datavis3dqml2/declarativemaps.h @@ -44,7 +44,7 @@ #include "maps3dcontroller_p.h" #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include "declarativemaps_p.h" #include <qsgsimpletexturenode.h> diff --git a/src/datavis3dqml2/declarativemaps_p.h b/src/datavis3dqml2/declarativemaps_p.h index 07e38cd9..1efe9523 100644 --- a/src/datavis3dqml2/declarativemaps_p.h +++ b/src/datavis3dqml2/declarativemaps_p.h @@ -43,7 +43,7 @@ #define DECLARATIVEMAPS_P_H #include "qdatavis3dglobal.h" -#include "qdatavis3namespace.h" +#include "qdatavis3dnamespace.h" #include <QString> QT_DATAVIS3D_BEGIN_NAMESPACE |