diff options
| -rw-r--r-- | src/doc/src/qtivi.qdoc | 2 | ||||
| -rw-r--r-- | src/ivicore/doc/src/qtivicore.qdoc | 27 | ||||
| -rw-r--r-- | src/ivicore/qtiviabstractfeature.cpp | 56 | ||||
| -rw-r--r-- | src/ivicore/qtiviabstractzonedfeature.cpp | 2 | ||||
| -rw-r--r-- | src/ivicore/qtiviproperty.cpp | 2 | ||||
| -rw-r--r-- | src/ivicore/qtivipropertyattribute.cpp | 29 | ||||
| -rw-r--r-- | src/ivicore/qtivipropertyfactory.cpp | 6 | ||||
| -rw-r--r-- | src/ivicore/qtiviservicemanager.cpp | 17 | ||||
| -rw-r--r-- | src/ivicore/qtiviserviceobject.cpp | 4 | ||||
| -rw-r--r-- | src/ivicore/qtivizonedfeatureinterface.cpp | 2 | ||||
| -rw-r--r-- | src/ivivehiclefunctions/doc/src/examples-climate_qml.qdoc | 2 | ||||
| -rw-r--r-- | src/ivivehiclefunctions/doc/src/examples-climate_widget.qdoc | 8 | ||||
| -rw-r--r-- | src/ivivehiclefunctions/doc/src/qtivivehiclefunctions.qdoc | 18 | ||||
| -rw-r--r-- | src/ivivehiclefunctions/qtiviclimatecontrol.cpp | 20 | ||||
| -rw-r--r-- | src/ivivehiclefunctions/qtiviclimatecontrolbackendinterface.cpp | 2 |
15 files changed, 99 insertions, 98 deletions
diff --git a/src/doc/src/qtivi.qdoc b/src/doc/src/qtivi.qdoc index c559c3d..95e327a 100644 --- a/src/doc/src/qtivi.qdoc +++ b/src/doc/src/qtivi.qdoc @@ -29,7 +29,7 @@ \title Qt IVI \keyword QtIVI - The Qt IVI (In-Vehicle Infotainment) provides C++ classes and QML types + The Qt IVI (In-Vehicle Infotainment) module provides C++ classes and QML types for accessing vehicle features, as well as a core API for implementing new IVI features. diff --git a/src/ivicore/doc/src/qtivicore.qdoc b/src/ivicore/doc/src/qtivicore.qdoc index 7f5e83c..6d5b3f3 100644 --- a/src/ivicore/doc/src/qtivicore.qdoc +++ b/src/ivicore/doc/src/qtivicore.qdoc @@ -40,9 +40,9 @@ demonstrator APIs that can be used as a starting point or off-the-shelf in your projects. The pattern is based around separation of the API facing the application developer, the so - called \e {Feature}, and the code implementing the said API, the \e {Backend}. There can be - multiple backends per feature and the Core module provides support for finding the corresponding - backend in an easy to use way. + called \e {Feature}, and the code implementing it, the \e {Backend}. There can be multiple + backends per feature and the Core module provides support for finding the corresponding + backend in an easy-to-use way. Common use cases driving this separation are: @@ -51,7 +51,7 @@ implementation. \li \e {Testing / Simulation}, where the backends can be tested separately from the app and the app can be tested using a specialized testing backend. - \li \e {Targets with different hardware configurations}, where parts of the system is + \li \e {Targets with different hardware configurations}, where certain parts of the system are represented by simulated backends while others use a real hardware integration. \li \e {Dynamically appearing services}, when services are available sometimes, but not always, meaning that backends come and go over time. @@ -115,7 +115,7 @@ finding the right service object for each feature instance. QtIVIServiceManager can be used in this case to manually search for plugins with a specific - BackendInterface. All the discovery and loading of the backends takes place in this class. + BackendInterface. The discovery and loading of the backends takes place in this class. The QtIVIServiceManager class can also be used to register backends which are part of the same application and shouldn’t go into a plugin. This is especially useful for autotest as you need @@ -124,33 +124,32 @@ \section1 Extending Qt IVI For easy deployment, Qt IVI extensions should be built as Qt modules. This makes it easy to - install and find headers, shared libraries as well as plugin modules from app projects. + install and find headers, shared libraries, and plugin modules from app projects. - By using the module system the developer benefits from easily enable the inclusion of your - module by using + By using the module system the developer can easily enable the inclusion of his + module in the following way: \code QT += <module> \endcode - In addition your module is properly setup to also work with cmake and the qdoc environment is - already setup, not to speak about the automatic test execution when using + In addition, your module is properly set up to work with cmake, qdoc, and auto test." \code make tests \endcode When creating a new Qt IVI module, it is recommended that you pick a name such as - \e {OemFeatureName}, where \e {Oem} is the name of the car-maker or platform owner, and + \e {OemFeatureName}, where \e {Oem} is the name of the car maker or platform owner, and \e {FeatureName} is the name of the feature(s) of the module. In addition to the name, a reverse - domain name prefix is needed for prefixing backend interface names, e.g. \e {com.example}. + domain name prefix is needed for prefixing backend interface names, for example \e {com.example}. Notice that it is possible to have multiple feature element classes in a single module. For - instance, the media module of Qt IVI contains both source discovery, media search and media + instance, the media module of Qt IVI contains both source discovery, media search, and media browse APIs. Having decided on a name and a backend interface name prefix, the template module can be checked - out from git. Then the renamer script is used to create the module, e.g: + out from git. Then the renamer script is used to create the module, for example: \code ./renamer.sh Oem MyFeature com.pelagicore diff --git a/src/ivicore/qtiviabstractfeature.cpp b/src/ivicore/qtiviabstractfeature.cpp index 607ab85..1a55b96 100644 --- a/src/ivicore/qtiviabstractfeature.cpp +++ b/src/ivicore/qtiviabstractfeature.cpp @@ -63,14 +63,14 @@ void QtIVIAbstractFeaturePrivate::setDiscoveryResult(QtIVIAbstractFeature::Disco * \inmodule QtIVICore * \brief The QtIVIAbstractFeature is the base class for all QtIVI Features * - * QtIVIAbstractFeature is the base class for the front facing API towards the Developer. - * The QtIVIAbstractFeature provides you with a way to automatically connect to a Backend implementing - * your needed interface. This discovery is started by using the startAutoDiscovery() function. + * QtIVIAbstractFeature is the base class for the front facing API towards the developer. + * The QtIVIAbstractFeature provides you with a way to automatically connect to a backend implementing + * the interface needed. This discovery is started by using the startAutoDiscovery() function. * * Once the auto discovery is done, it can be checked whether a backend has been found by using the * isValid function. * - * The auto discovery gives you a easy way to automatically connect to the right backend implementation. + * The auto discovery gives you an easy way to automatically connect to the right backend implementation. * If you don't want to use the auto discovery, it's also possible to use QtIVIServiceManager to retrieve * all Backends and search manually for the right one and connect it to the QtIVIAbstractFeature by calling * setServiceObject(). @@ -78,12 +78,12 @@ void QtIVIAbstractFeaturePrivate::setDiscoveryResult(QtIVIAbstractFeature::Disco * The type of backend to be loaded can be controlled by setting the auto discovery mode. By default, * it is set to AutoDiscovery, which indicates that a production backend will be preferred over a simulation backend. * - * QtIVIAbstractFeature is a abstract base class which needs to be subclassed to create a API for your + * QtIVIAbstractFeature is an abstract base class that needs to be subclassed to create an API for your * Feature. * * \chapter Subclassing * - * When subclassing QtIVIAbstractFeature you must provide implementations of the following functions: + * When subclassing QtIVIAbstractFeature, you must provide implementations of the following functions: * \list * \li acceptServiceObject() * \li connectToServiceObject() @@ -91,14 +91,14 @@ void QtIVIAbstractFeaturePrivate::setDiscoveryResult(QtIVIAbstractFeature::Disco * \li clearServiceObject() * \endlist * - * Once a QtIVIServiceObject has be set, either by auto discovery or by manually setting it the acceptServiceObject() - * function will be called to make sure the QtIVIServiceObject provides everything which is needed by the Feature. + * Once a QtIVIServiceObject has been set, either by auto discovery or by manually setting it, the acceptServiceObject() + * function will be called to make sure the QtIVIServiceObject provides everything needed by the Feature. * - * If the interface provides signals you need to do all the connect statements in connectToServiceObject() and + * If the interface provides signals, you need to do all the connect statements in connectToServiceObject() and * disconnect them again in disconnectFromServiceObject(). * * clearServiceObject() will be called once the Feature doesn't have a connection to a ServiceObject anymore and should - * reset it's state to sane defaults + * reset its state to sane defaults. */ /*! @@ -178,7 +178,7 @@ void QtIVIAbstractFeaturePrivate::setDiscoveryResult(QtIVIAbstractFeature::Disco * The implementation is expected to connect to the service object, \a so, and to set all * properties to reflect the state of the service object. * - * There is no previous service object connected, as this call always is preceeded by a call to + * There is no previous service object connected, as this function call is always preceded by a call to * \l disconnectFromServiceObject or \l clearServiceObject. * * It is safe to assume that the service object, \a so, has always been accepted through the @@ -280,17 +280,17 @@ void QtIVIAbstractFeature::setServiceObject(QtIVIServiceObject *so) /*! * \qmlproperty enumeration AbstractFeature::discoveryMode - * \brief Holds the mode which is used for the autodiscovery + * \brief Holds the mode that is used for the autoDiscovery * * Available values are: * \value NoAutoDiscovery - * No Auto Discovery is done and the ServiceObject needs to be set manually + * No Auto Discovery is done and the ServiceObject needs to be set manually. * \value AutoDiscovery - * Tries to first find a production backend with a matching interface and falls back to a simulation backend if not found + * Tries to find a production backend with a matching interface and falls back to a simulation backend if not found. * \value LoadOnlyProductionBackends - * Only tries to load a production backend with a matching interface + * Only tries to load a production backend with a matching interface. * \value LoadOnlySimulationBackends - * Only tries to load a simulation backend with a matching interface + * Only tries to load a simulation backend with a matching interface. * * If needed the auto discovery will be started once the Item is created. * @@ -300,7 +300,7 @@ void QtIVIAbstractFeature::setServiceObject(QtIVIServiceObject *so) /*! * \property QtIVIAbstractFeature::discoveryMode - * \brief Holds the mode which is used for the autodiscovery + * \brief Holds the mode that is used for the autoDiscovery * * \sa startAutoDiscovery() */ @@ -357,22 +357,22 @@ QtIVIAbstractFeature::DiscoveryMode QtIVIAbstractFeature::discoveryMode() const /*! * \qmlproperty enumeration AbstractFeature::autoDiscoveryResult - * \brief Holds the result of the last run of the auto discovery + * \brief Holds the result of the last autoDiscovery * * Available values are: * \value NoResult - * Indicates that no auto discovery was started because the feature has already assigned a valid ServiceObject + * Indicates that no auto discovery was started because the feature has already assigned a valid ServiceObject. * \value ErrorWhileLoading - * An error has happened while searching for a backend with a matching interface + * An error has happened while searching for a backend with a matching interface. * \value ProductionBackendLoaded - * As a result of the auto discovery a production backend was loaded + * As a result of the auto discovery a production backend was loaded. * \value SimulationBackendLoaded - * As a result of the auto discovery a simulation backend was loaded + * As a result of the auto discovery a simulation backend was loaded. */ /*! * \property QtIVIAbstractFeature::discoveryResult - * \brief Holds the result of the last run of the auto discovery + * \brief Holds the result of the last autoDiscovery * * \sa startAutoDiscovery() */ @@ -459,13 +459,13 @@ QString QtIVIAbstractFeature::errorText() const * * Return values are: * \value NoResult - * Indicates that no auto discovery was started because the feature has already assigned a valid ServiceObject + * Indicates that no auto discovery was started because the feature has already assigned a valid ServiceObject. * \value ErrorWhileLoading - * An error has happened while searching for a backend with a matching interface + * An error has happened while searching for a backend with a matching interface. * \value ProductionBackendLoaded - * As a result of the auto discovery a production backend was loaded + * As a result of the auto discovery a production backend was loaded. * \value SimulationBackendLoaded - * As a result of the auto discovery a simulation backend was loaded + * As a result of the auto discovery a simulation backend was loaded. */ /*! @@ -531,7 +531,7 @@ QtIVIAbstractFeature::DiscoveryResult QtIVIAbstractFeature::startAutoDiscovery() /*! * \qmlproperty bool AbstractFeature::isValid - * \brief Holds whether the feature is ready to use. + * \brief Holds whether the feature is ready for use. * * The property holds \c true if the feature is ready to be used, otherwise \c false. Not being * ready usually indicates that no suitable service object could be found, or that automatic diff --git a/src/ivicore/qtiviabstractzonedfeature.cpp b/src/ivicore/qtiviabstractzonedfeature.cpp index 78d3e8e..fc252d4 100644 --- a/src/ivicore/qtiviabstractzonedfeature.cpp +++ b/src/ivicore/qtiviabstractzonedfeature.cpp @@ -45,7 +45,7 @@ QtIVIAbstractZonedFeaturePrivate::QtIVIAbstractZonedFeaturePrivate(const QString \since 5.6 - \brief The QtIVIAbstractZonedFeature is base class for all QtIVI vehicle features. + \brief The QtIVIAbstractZonedFeature is the base class for all QtIVI vehicle features. QtIVIAbstractZonedFeature contains all feature attributes and zone handling. */ diff --git a/src/ivicore/qtiviproperty.cpp b/src/ivicore/qtiviproperty.cpp index b1f06fe..38beb08 100644 --- a/src/ivicore/qtiviproperty.cpp +++ b/src/ivicore/qtiviproperty.cpp @@ -63,7 +63,7 @@ void QtIVIPropertyPrivate::throwError(QObject *object, const QString &error) * QtIVIPropertyAttribute in an easy way. It's designed for QML (but is not limited to) * and acts as a Grouped Property. * - * Although the QtIVIProperty only contains QVariant properties its still also stores + * Although the QtIVIProperty only contains QVariant properties, it still stores * the real type of the value and checks that only values of the correct type can be * stored in it. * The QtIVIProperty doesn't store a copy of the values, instead it just acts as a diff --git a/src/ivicore/qtivipropertyattribute.cpp b/src/ivicore/qtivipropertyattribute.cpp index c2c1929..eecff7c 100644 --- a/src/ivicore/qtivipropertyattribute.cpp +++ b/src/ivicore/qtivipropertyattribute.cpp @@ -34,29 +34,30 @@ * \inmodule QtIVICore * \brief The QtIVIPropertyAttribute encapsulates the attributes of a property * - * QtIVIPropertyAttribute sets the boundaries for a property in QtIVI. In a - * QtIVI backend interface the QtIVIPropertyAttributes are used to control + * QtIVIPropertyAttribute sets the boundaries for a property in Qt IVI. In a + * Qt IVI backend interface, the QtIVIPropertyAttributes are used to control * which properties are implemented by a backend and to set the boundaries like * the minimum or the maximum value of a property. * - * By default a QtIVIPropertyAttribute is initialized with the type: Invalid - * and indicates that this property is not available. This could be the case + * By default a QtIVIPropertyAttribute is initialized with the "Invalid" type, + * which indicates that this property is not available. This could be the case * when the backend doesn't support this property or the property is not available - * because the current backend configuration does not supported it. - * (e.g. a property can be supported by a specific car configuration, but is not part of another). + * because the current backend configuration does not support it. + * For example, a property can be supported by a specific car configuration, + * but is not part of another. */ /*! * \enum QtIVIPropertyAttributeBase::AttributeType * * \value Invalid - * The Attribute is invalid and is not available + * The attribute is invalid and is not available. * \value NoAttributes - * No additional attributes for the property are provided + * No additional attributes for the property are provided. * \value MinimumMaximum - * The Attribute defines the minimum and the maximum Value of the property + * The attribute defines the minimum and the maximum value of the property. * \value AvailableValues - * The Attribute defines a list of values which are available for the property + * The attribute defines a list of values that are available for the property. */ /*! @@ -64,14 +65,14 @@ * Constructs an invalid QtIVIPropertyAttribute. * * This constructor can be used to indicate that the property is not available. - * For example because the backend doesn't support this property. + * For example, because the backend doesn't support this property. */ /*! * \fn QtIVIPropertyAttribute::QtIVIPropertyAttribute(bool available) * Constructs an QtIVIPropertyAttribute of type NoAttributes. * - * The argument \a available defines whether the property is supported by the backend + * The argument \a available defines whether the property is supported by the backend. */ /*! @@ -104,14 +105,14 @@ * \fn T QtIVIPropertyAttribute::minimumValue() const * * Returns the minimum value of the property. - * If the attributeType is not MinimumMaximum a default constructed value is returned. + * If the attributeType is not MinimumMaximum, a default constructed value is returned. */ /*! * \fn T QtIVIPropertyAttribute::maximumValue() const * * Returns the maximum value of the property. - * If the attributeType is not MinimumMaximum a default constructed value is returned. + * If the attributeType is not MinimumMaximum, a default constructed value is returned. */ /*! diff --git a/src/ivicore/qtivipropertyfactory.cpp b/src/ivicore/qtivipropertyfactory.cpp index 50c96ed..8834b3a 100644 --- a/src/ivicore/qtivipropertyfactory.cpp +++ b/src/ivicore/qtivipropertyfactory.cpp @@ -32,7 +32,7 @@ /*! * \class QtIVIPropertyFactory * \inmodule QtIVICore - * \brief The QtIVIPropertyFactory ist used as a factory class for creating instances of QtIVIProperty + * \brief The QtIVIPropertyFactory is used as a factory class for creating instances of QtIVIProperty * * QtIVIPropertyFactory will preserve the type information about the template type in QtIVIProperty and * does a compile time check whether all provided functions and signals match this type and each other. @@ -58,7 +58,7 @@ * The \a sender argument needs to be a pointer to the QObject* instance which implements all functions and signals provided next. * The arguments \a attributeGetter and \a attributeSignal need to be functions pointers to your attribute getter function and the attribute signal function. * These arguments need to be of QtIVIPropertyAttribute<T>. - * \a valueGetter, \a valueSignal and \a valueSlot need to be function pointers to the getter, signal and setter for the value which should be stored in this QtIVIQmlProperty instance. + * \a valueGetter, \a valueSignal, and \a valueSlot need to be function pointers to the getter, signal, and setter for the value that should be stored in this QtIVIQmlProperty instance. * The value functions need to have arguments and return values of type T. * * \sa QtIVIPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal) @@ -67,7 +67,7 @@ /*! * \fn QtIVIPropertyFactory::create(const QtPrivate::FunctionPointer<attributeGetterFunc>::Object *sender, attributeGetterFunc attributeGetter, attributeSignalFunc attributeSignal, valueGetterFunc valueGetter, valueSignalFunc valueSignal) * - * Returns an new QtIVIProperty instance for a attribute and value of type T. + * Returns a new QtIVIProperty instance for an attribute and value of type T. * * The \a sender argument needs to be a pointer to the QObject* instance which implements all functions and signals provided next. * The arguments \a attributeGetter and \a attributeSignal need to be functions pointers to your attribute getter function and the attribute signal function. diff --git a/src/ivicore/qtiviservicemanager.cpp b/src/ivicore/qtiviservicemanager.cpp index f5e4b0f..071dc91 100644 --- a/src/ivicore/qtiviservicemanager.cpp +++ b/src/ivicore/qtiviservicemanager.cpp @@ -230,12 +230,12 @@ QtIVIServiceInterface *QtIVIServiceManagerPrivate::loadServiceBackendInterface(s * \inmodule QtIVICore * \brief QtIVIServiceManager provides the Backends to QtIVIAbstractFeature * - * QtIVIServiceManager is the heart of QtIVI and provides you a easy way to detect what - * Backends and interfaces are available. + * QtIVIServiceManager is the heart of QtIVI and provides you with an easy way to detect which + * backends and interfaces are available. * * By default QtIVIServiceManager reads the metaData of all plugins within the "qtivi" folder * of your plugin path. The plugin itself will be loaded once it's explictly requested by - * the developer by using findServiceByInterface() + * the developer by using findServiceByInterface(). * * The registerService() function can be used to add Backend classes without putting them into * a plugin. @@ -288,7 +288,7 @@ QtIVIServiceManager::~QtIVIServiceManager() } /*! - * Returns a List of Backends which implementing the specified \a interface. + * Returns a list of backends implementing the specified \a interface. * * The \a searchFlags argument can be used to control which type of backends are included in the search result. */ @@ -299,10 +299,11 @@ QList<QtIVIServiceObject *> QtIVIServiceManager::findServiceByInterface(const QS } /*! - * Register a backend. The provided \a serviceBackendInterface must implement the QtIVIServiceInterface else - * the registration will fail. \a interfaces is list with interfaces which the backend handles. At least one - * interface is required. The \a backendType indicates the type of the backend and has influence on whether the - * backend is found by the auto discovery of the Feature. + * Register a backend. The provided \a serviceBackendInterface must implement the + * QtIVIServiceInterface else the registration will fail. \a interfaces is a list + * with interfaces (at least one) supported by the backend. The \a backendType + * indicates the type of the backend and has influence on whether the backend is + * found by the auto discovery of the Feature. * * Returns true if the backend was successfully registered else false. * diff --git a/src/ivicore/qtiviserviceobject.cpp b/src/ivicore/qtiviserviceobject.cpp index 4ed3228..2155805 100644 --- a/src/ivicore/qtiviserviceobject.cpp +++ b/src/ivicore/qtiviserviceobject.cpp @@ -34,12 +34,12 @@ /*! * \class QtIVIServiceObject * \inmodule QtIVICore - * \brief QtIVIServiceObject is the connection point to a Backend Service + * \brief QtIVIServiceObject is the connection point to a Backend Service. * * QtIVIServiceObject provides you with a list of interfaces the Backend implements. * * By using interfaceInstance() a QObject implementing this interface will be returned. - * The returned interface can contain signals which needs to be connected to by the Feature + * The returned interface can contain signals that need to be connected to by the Feature * implementing this interface. * * \sa QtIVIAbstractFeature diff --git a/src/ivicore/qtivizonedfeatureinterface.cpp b/src/ivicore/qtivizonedfeatureinterface.cpp index e883009..4958c58 100644 --- a/src/ivicore/qtivizonedfeatureinterface.cpp +++ b/src/ivicore/qtivizonedfeatureinterface.cpp @@ -158,7 +158,7 @@ QtIVIZonedFeatureInterface::QtIVIZonedFeatureInterface(QObject *parent) * \fn QStringList QtIVIZonedFeatureInterface::availableZones() const * * Returns a list of supported zone names. This is called from the client - * right after it's connected. + * after having connected. * * The returned names must be valid QML property names, i.e. \c {[a-z_][A-Za-z0-9_]*}. * diff --git a/src/ivivehiclefunctions/doc/src/examples-climate_qml.qdoc b/src/ivivehiclefunctions/doc/src/examples-climate_qml.qdoc index e8e3625..49bcdf0 100644 --- a/src/ivivehiclefunctions/doc/src/examples-climate_qml.qdoc +++ b/src/ivivehiclefunctions/doc/src/examples-climate_qml.qdoc @@ -35,7 +35,7 @@ \brief The Example shows how to access the climate control from QML. \image examples_climate_qml.png - The example shows how to access the climate control from the QML. + The example shows how to access the climate control from QML. In the example, ClimateControl is created and autoDiscovery enabled. When autoDiscovery is enabled, the module starts searching for the presence diff --git a/src/ivivehiclefunctions/doc/src/examples-climate_widget.qdoc b/src/ivivehiclefunctions/doc/src/examples-climate_widget.qdoc index 9eaad12..da5d56d 100644 --- a/src/ivivehiclefunctions/doc/src/examples-climate_widget.qdoc +++ b/src/ivivehiclefunctions/doc/src/examples-climate_widget.qdoc @@ -32,19 +32,19 @@ \title Climate Control Widget Example \ingroup qtivivehiclefunctions_examples - \brief The Example shows how to access the climate control from C++. + \brief This example shows how to access the climate control from C++. \image examples_climate_widget.png - The example shows how to access the climate control from the C++. + This example shows how to access the climate control from the C++. The first thing to do is to create a QtIVIClimateControl instance in our MainWindow constructor. As we only have one Climate backend and don't want - to choose which to use, we call \l {QtIVIAbstractFeature::}{startAutoDiscovery()} + to choose which one to use, we call \l {QtIVIAbstractFeature::}{startAutoDiscovery()} to start searching for a suitable backend right away and pick the first one that matches. \l {QtIVIClimateControl::}{isValid()} is used for verifying that the - autodiscovery found a backend: + autoDiscovery found a backend: \snippet climate_widget/mainwindow.cpp 1 The constructor then continues to connect the climate control diff --git a/src/ivivehiclefunctions/doc/src/qtivivehiclefunctions.qdoc b/src/ivivehiclefunctions/doc/src/qtivivehiclefunctions.qdoc index 7fc3355..512e825 100644 --- a/src/ivivehiclefunctions/doc/src/qtivivehiclefunctions.qdoc +++ b/src/ivivehiclefunctions/doc/src/qtivivehiclefunctions.qdoc @@ -87,14 +87,14 @@ m_climateControl->setAirConditioningEnabled(true); \endcode - Some features, like climate control is also divided into several climate zones. The names + Some features, like climate control, are divided into several climate zones. The names of the available zones can be checked using QtIVIAbstractZonedFeature::availableZones(): \code QStringList zones = m_climateControl->availableZones(); \endcode - Accessing to zone functions, you can use QtIVIAbstractZonedFeature::zoneAt(): + You can use QtIVIAbstractZonedFeature::zoneAt() to access zone functions: \code m_climateControl->zoneAt("FrontSeat")->setSeatHeater(false); @@ -117,7 +117,7 @@ \brief QML types for the Qt IVI Vehicle Functions API. - The Qt IVI Vehicle Functions QML API provides simple way to use vehicle + The Qt IVI Vehicle Functions QML API provides a simple way to use vehicle features in QML applications. \section1 Getting Started @@ -125,7 +125,7 @@ The QML application relies on the QML plugin loading capabilities of the Qt QML runtime. This means that an installed Qt IVI module is found automatically. - To import Qt IVI Vehicle Functions QML types, add the following import + To import the Qt IVI Vehicle Functions QML types, add the following import statement to your \c .qml file: \snippet doc_src_qmlivivehiclefunctions.cpp 0 @@ -152,8 +152,8 @@ } \endcode - Some features, like climate control is divided into zones. The names of the available zones - can be fetched from the AbstractZonedFeature::availableZones. Zones are available only + Some features, like climate control, are divided into zones. The names of the available zones + can be fetched with AbstractZonedFeature::availableZones. Zones are available only when the feature is valid. \code ComboBox { @@ -161,12 +161,12 @@ } \endcode - With AbstractZonedFeature::zoneAt property you can access to the climate control zone specific functions. + With the AbstractZonedFeature::zoneAt property you can access the climate control zone-specific functions. \code climateControl.zoneAt.FrontSeat.seatheater = true \endcode - Zones can used in model by AbstractZonedFeature::zones property. + An example of how to use the AbstractZonedFeature::zones property: \code Repeater { model: climateControl.zones @@ -174,7 +174,7 @@ } \endcode - Interactions with the feature element is described in the feature documentation. It is possible + Interactions with the feature element are described in the feature documentation. It is possible to bind properties, call methods, and listen to signals. \section1 QML Types diff --git a/src/ivivehiclefunctions/qtiviclimatecontrol.cpp b/src/ivivehiclefunctions/qtiviclimatecontrol.cpp index b78db88..bfc6519 100644 --- a/src/ivivehiclefunctions/qtiviclimatecontrol.cpp +++ b/src/ivivehiclefunctions/qtiviclimatecontrol.cpp @@ -464,7 +464,7 @@ bool QtIVIClimateControl::isAirConditioningEnabled() const } /*! - * Returns the attribute defining the boundaries and availability of the air conditioning property + * Returns the attribute defining the boundaries and availability of the air conditioning property. * * \sa setAirConditioningEnabled() isAirConditioningEnabled() airConditioningEnabledChanged() */ @@ -486,7 +486,7 @@ QtIVIProperty *QtIVIClimateControl::airConditioningProperty() const \e value holds the airflow direction. Available values are: \value None - AirflowDirection is not initialized + AirflowDirection is not initialized. \value FloorPanel Direct airflow along the floor panel. \value FloorDuct @@ -558,7 +558,7 @@ bool QtIVIClimateControl::isHeaterEnabled() const } /*! - * Returns the attribute defining the boundaries and availability of the heater property + * Returns the attribute defining the boundaries and availability of the heater property. * * \sa setHeaterEnabled() isHeaterEnabled() heaterEnabledChanged() */ @@ -599,7 +599,7 @@ bool QtIVIClimateControl::isAirRecirculationEnabled() const } /*! - * Returns the attribute defining the boundaries and availability of the air recirculation property + * Returns the attribute defining the boundaries and availability of the air recirculation property. * * \sa setAirRecirculationEnabled() isAirRecirculationEnabled() airRecirculationEnabledChanged() */ @@ -644,7 +644,7 @@ int QtIVIClimateControl::steeringWheelHeater() const } /*! - * Returns the attribute defining the boundaries and availability of the steering wheel heater property + * Returns the attribute defining the boundaries and availability of the steering wheel heater property. * * \sa setSteeringWheelHeater() steeringWheelHeater() steeringWheelHeaterChanged() */ @@ -705,8 +705,8 @@ QtIVIProperty *QtIVIClimateControl::fanSpeedLevelProperty() const /*! \qmlqtiviproperty {int} {QtIVIVehicleFunctions::ClimateControl::targetTemperature} - \e value holds the target temperature of the zone expressed in centigrades, where the temperature can be between \c minimumValue(off) - to \c maximumValue (strongest). + \e value holds the target temperature of the zone expressed in centigrades, where the temperature can be between \c minimumValue(off) + to \c maximumValue (strongest). */ /*! \property QtIVIClimateControl::targetTemperature @@ -728,7 +728,7 @@ int QtIVIClimateControl::targetTemperature() const } /*! - * Returns the attribute defining the boundaries and availability of the target temperature property + * Returns the attribute defining the boundaries and availability of the target temperature property. * * \sa setTargetTemperature() targetTemperature() targetTemperatureChanged() */ @@ -770,7 +770,7 @@ int QtIVIClimateControl::seatCooler() const } /*! - * Returns the attribute defining the boundaries and availability of the seat cooler property + * Returns the attribute defining the boundaries and availability of the seat cooler property. * * \sa setSeatCooler() seatCooler() seatCoolerChanged() */ @@ -812,7 +812,7 @@ int QtIVIClimateControl::seatHeater() const } /*! - * Returns the attribute defining the boundaries and availability of the seat heater property + * Returns the attribute defining the boundaries and availability of the seat heater property. * * \sa setSeatHeater() seatHeater() seatHeaterChanged() */ diff --git a/src/ivivehiclefunctions/qtiviclimatecontrolbackendinterface.cpp b/src/ivivehiclefunctions/qtiviclimatecontrolbackendinterface.cpp index 07fd4d5..b636066 100644 --- a/src/ivivehiclefunctions/qtiviclimatecontrolbackendinterface.cpp +++ b/src/ivivehiclefunctions/qtiviclimatecontrolbackendinterface.cpp @@ -60,7 +60,7 @@ QtIVIClimateControlBackendInterface::QtIVIClimateControlBackendInterface(QObject /*! * \fn virtual void QtIVIClimateControlBackendInterface::setTargetTemperature(int value, const QString &zone) = 0 * - * Sets the target temperature of \a zone to \a value, wheret he \a value is expressed in + * Sets the target temperature of \a zone to \a value, where the \a value is expressed in * centigrades and may be range limited by the backend. * * This method is expected to emit a \l targetTemperatureChanged() signal when receiving a new |