Very minor C++ doc changes

Reordering some enum's so values are listed ascending
Replace 'The' with 'the' in some briefs

Change-Id: Ibc5042389687598ddaaf11e72acaa688b85fd4cf
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Reviewed-by: Ling Hu <ling.hu@nokia.com>
This commit is contained in:
Angus Cummings
2012-05-11 11:13:45 +10:00
committed by Qt by Nokia
parent 9e6d03584a
commit b96ca81108
7 changed files with 18 additions and 18 deletions

View File

@@ -430,9 +430,9 @@ QAudioBuffer QAudioDecoder::read() const
Defines the current state of a media player. Defines the current state of a media player.
\value DecodingState The audio player is currently decoding media.
\value StoppedState The decoder is not decoding. Decoding will \value StoppedState The decoder is not decoding. Decoding will
start at the start of the media. start at the start of the media.
\value DecodingState The audio player is currently decoding media.
*/ */
/*! /*!

View File

@@ -615,9 +615,9 @@ void QCameraExposure::setAutoShutterSpeed()
/*! /*!
\enum QCameraExposure::FlashMode \enum QCameraExposure::FlashMode
\value FlashAuto Automatic flash.
\value FlashOff Flash is Off. \value FlashOff Flash is Off.
\value FlashOn Flash is On. \value FlashOn Flash is On.
\value FlashAuto Automatic flash.
\value FlashRedEyeReduction Red eye reduction flash. \value FlashRedEyeReduction Red eye reduction flash.
\value FlashFill Use flash to fillin shadows. \value FlashFill Use flash to fillin shadows.
\value FlashTorch Constant light source. If supported, \value FlashTorch Constant light source. If supported,
@@ -635,8 +635,9 @@ void QCameraExposure::setAutoShutterSpeed()
/*! /*!
\enum QCameraExposure::ExposureMode \enum QCameraExposure::ExposureMode
\value ExposureManual Manual mode.
\value ExposureAuto Automatic mode. \value ExposureAuto Automatic mode.
\value ExposureManual Manual mode.
\value ExposurePortrait Portrait exposure mode.
\value ExposureNight Night mode. \value ExposureNight Night mode.
\value ExposureBacklight Backlight exposure mode. \value ExposureBacklight Backlight exposure mode.
\value ExposureSpotlight Spotlight exposure mode. \value ExposureSpotlight Spotlight exposure mode.
@@ -645,16 +646,15 @@ void QCameraExposure::setAutoShutterSpeed()
\value ExposureBeach Beach exposure mode. \value ExposureBeach Beach exposure mode.
\value ExposureLargeAperture Use larger aperture with small depth of field. \value ExposureLargeAperture Use larger aperture with small depth of field.
\value ExposureSmallAperture Use smaller aperture. \value ExposureSmallAperture Use smaller aperture.
\value ExposurePortrait Portrait exposure mode.
\value ExposureModeVendor The base value for device specific exposure modes. \value ExposureModeVendor The base value for device specific exposure modes.
*/ */
/*! /*!
\enum QCameraExposure::MeteringMode \enum QCameraExposure::MeteringMode
\value MeteringMatrix Matrix metering mode.
\value MeteringAverage Center weighted average metering mode. \value MeteringAverage Center weighted average metering mode.
\value MeteringSpot Spot metering mode. \value MeteringSpot Spot metering mode.
\value MeteringMatrix Matrix metering mode.
*/ */
/*! /*!

View File

@@ -409,7 +409,7 @@ bool QCameraFocus::isAvailable() const
/*! /*!
\property QCameraFocus::focusMode \property QCameraFocus::focusMode
\brief The current camera focus mode. \brief the current camera focus mode.
This controls the way the camera lens assembly is configured. This controls the way the camera lens assembly is configured.
@@ -438,7 +438,7 @@ bool QCameraFocus::isFocusModeSupported(FocusModes mode) const
/*! /*!
\property QCameraFocus::focusPointMode \property QCameraFocus::focusPointMode
\brief The current camera focus point selection mode. \brief the current camera focus point selection mode.
If the camera focus mode is set to use an autofocusing mode, If the camera focus mode is set to use an autofocusing mode,
this property controls the way the camera will select areas this property controls the way the camera will select areas
@@ -524,7 +524,7 @@ qreal QCameraFocus::maximumDigitalZoom() const
/*! /*!
\property QCameraFocus::opticalZoom \property QCameraFocus::opticalZoom
\brief The current optical zoom value. \brief the current optical zoom value.
\sa QCameraFocus::digitalZoom \sa QCameraFocus::digitalZoom
*/ */
@@ -536,7 +536,7 @@ qreal QCameraFocus::opticalZoom() const
/*! /*!
\property QCameraFocus::digitalZoom \property QCameraFocus::digitalZoom
\brief The current digital zoom value. \brief the current digital zoom value.
\sa QCameraFocus::opticalZoom \sa QCameraFocus::opticalZoom
*/ */
@@ -562,12 +562,12 @@ void QCameraFocus::zoomTo(qreal optical, qreal digital)
\enum QCameraFocus::FocusMode \enum QCameraFocus::FocusMode
\value ManualFocus Manual or fixed focus mode. \value ManualFocus Manual or fixed focus mode.
\value AutoFocus One-shot auto focus mode.
\value ContinuousFocus Continuous auto focus mode.
\value InfinityFocus Focus strictly to infinity.
\value HyperfocalFocus Focus to hyperfocal distance, with the maximum depth of field achieved. \value HyperfocalFocus Focus to hyperfocal distance, with the maximum depth of field achieved.
All objects at distances from half of this All objects at distances from half of this
distance out to infinity will be acceptably sharp. distance out to infinity will be acceptably sharp.
\value InfinityFocus Focus strictly to infinity.
\value AutoFocus One-shot auto focus mode.
\value ContinuousFocus Continuous auto focus mode.
\value MacroFocus One shot auto focus to objects close to camera. \value MacroFocus One shot auto focus to objects close to camera.
*/ */

View File

@@ -499,7 +499,7 @@ void QCameraImageCapture::setCaptureDestination(QCameraImageCapture::CaptureDest
/*! /*!
\property QCameraImageCapture::readyForCapture \property QCameraImageCapture::readyForCapture
Indicates the service is ready to capture a an image immediately. \brief whether the service is ready to capture a an image immediately.
It's permissible to call capture() while the camera status is QCamera::ActiveStatus It's permissible to call capture() while the camera status is QCamera::ActiveStatus
regardless of isReadyForCapture property value. regardless of isReadyForCapture property value.
@@ -587,9 +587,9 @@ void QCameraImageCapture::cancelCapture()
\value NoError No Errors. \value NoError No Errors.
\value NotReadyError The service is not ready for capture yet. \value NotReadyError The service is not ready for capture yet.
\value ResourceError Device is not ready or not available. \value ResourceError Device is not ready or not available.
\value OutOfSpaceError No space left on device.
\value NotSupportedFeatureError Device does not support stillimages capture. \value NotSupportedFeatureError Device does not support stillimages capture.
\value FormatError Current format is not supported. \value FormatError Current format is not supported.
\value OutOfSpaceError No space left on device.
*/ */
/*! /*!

View File

@@ -317,9 +317,9 @@ void QCameraImageProcessing::setDenoisingLevel(qreal level)
/*! /*!
\enum QCameraImageProcessing::WhiteBalanceMode \enum QCameraImageProcessing::WhiteBalanceMode
\value WhiteBalanceAuto Auto white balance mode.
\value WhiteBalanceManual Manual white balance. In this mode the white balance should be set with \value WhiteBalanceManual Manual white balance. In this mode the white balance should be set with
setManualWhiteBalance() setManualWhiteBalance()
\value WhiteBalanceAuto Auto white balance mode.
\value WhiteBalanceSunlight Sunlight white balance mode. \value WhiteBalanceSunlight Sunlight white balance mode.
\value WhiteBalanceCloudy Cloudy white balance mode. \value WhiteBalanceCloudy Cloudy white balance mode.
\value WhiteBalanceShade Shade white balance mode. \value WhiteBalanceShade Shade white balance mode.

View File

@@ -1022,11 +1022,11 @@ QtMultimedia::AvailabilityError QMediaPlayer::availabilityError() const
Defines the current state of a media player. Defines the current state of a media player.
\value StoppedState The media player is not playing content, playback will begin from the start
of the current track.
\value PlayingState The media player is currently playing content. \value PlayingState The media player is currently playing content.
\value PausedState The media player has paused playback, playback of the current track will \value PausedState The media player has paused playback, playback of the current track will
resume from the position the player was paused at. resume from the position the player was paused at.
\value StoppedState The media player is not playing content, playback will begin from the start
of the current track.
*/ */
/*! /*!

View File

@@ -652,9 +652,9 @@ QRadioData *QRadioTuner::radioData() const
Enumerates radio tuner policy for receiving stereo signals. Enumerates radio tuner policy for receiving stereo signals.
\value Auto Uses the stereo mode matching the station.
\value ForceStereo Provide stereo mode, converting if required. \value ForceStereo Provide stereo mode, converting if required.
\value ForceMono Provide mono mode, converting if required. \value ForceMono Provide mono mode, converting if required.
\value Auto Uses the stereo mode matching the station.
*/ */
/*! \fn void QRadioTuner::stateChanged(QRadioTuner::State state) /*! \fn void QRadioTuner::stateChanged(QRadioTuner::State state)