Improve documented function argument names

Make them less \a fun.

Pick-to: 5.15 6.0
Change-Id: Ief9a572dcbeb029b18b352c89551963bade90198
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Allan Sandfeld Jensen 2020-09-25 10:17:09 +02:00
parent e236faa75f
commit 47923f7d47
3 changed files with 14 additions and 14 deletions

View File

@ -198,9 +198,9 @@ QColorSpacePrivate::QColorSpacePrivate(QColorSpace::NamedColorSpace namedColorSp
initialize(); initialize();
} }
QColorSpacePrivate::QColorSpacePrivate(QColorSpace::Primaries primaries, QColorSpace::TransferFunction fun, float gamma) QColorSpacePrivate::QColorSpacePrivate(QColorSpace::Primaries primaries, QColorSpace::TransferFunction transferFunction, float gamma)
: primaries(primaries) : primaries(primaries)
, transferFunction(fun) , transferFunction(transferFunction)
, gamma(gamma) , gamma(gamma)
{ {
identifyColorSpace(); identifyColorSpace();
@ -208,10 +208,10 @@ QColorSpacePrivate::QColorSpacePrivate(QColorSpace::Primaries primaries, QColorS
} }
QColorSpacePrivate::QColorSpacePrivate(const QColorSpacePrimaries &primaries, QColorSpacePrivate::QColorSpacePrivate(const QColorSpacePrimaries &primaries,
QColorSpace::TransferFunction fun, QColorSpace::TransferFunction transferFunction,
float gamma) float gamma)
: primaries(QColorSpace::Primaries::Custom) : primaries(QColorSpace::Primaries::Custom)
, transferFunction(fun) , transferFunction(transferFunction)
, gamma(gamma) , gamma(gamma)
{ {
Q_ASSERT(primaries.areValid()); Q_ASSERT(primaries.areValid());
@ -453,11 +453,11 @@ QColorSpace::QColorSpace(NamedColorSpace namedColorSpace)
} }
/*! /*!
Creates a custom color space with the primaries \a primaries, using the transfer function \a fun and Creates a custom color space with the primaries \a primaries, using the transfer function \a transferFunction and
optionally \a gamma. optionally \a gamma.
*/ */
QColorSpace::QColorSpace(QColorSpace::Primaries primaries, QColorSpace::TransferFunction fun, float gamma) QColorSpace::QColorSpace(QColorSpace::Primaries primaries, QColorSpace::TransferFunction transferFunction, float gamma)
: d_ptr(new QColorSpacePrivate(primaries, fun, gamma)) : d_ptr(new QColorSpacePrivate(primaries, transferFunction, gamma))
{ {
} }
@ -472,18 +472,18 @@ QColorSpace::QColorSpace(QColorSpace::Primaries primaries, float gamma)
/*! /*!
Creates a custom colorspace with a primaries based on the chromaticities of the primary colors \a whitePoint, Creates a custom colorspace with a primaries based on the chromaticities of the primary colors \a whitePoint,
\a redPoint, \a greenPoint and \a bluePoint, and using the transfer function \a fun and optionally \a gamma. \a redPoint, \a greenPoint and \a bluePoint, and using the transfer function \a transferFunction and optionally \a gamma.
*/ */
QColorSpace::QColorSpace(const QPointF &whitePoint, const QPointF &redPoint, QColorSpace::QColorSpace(const QPointF &whitePoint, const QPointF &redPoint,
const QPointF &greenPoint, const QPointF &bluePoint, const QPointF &greenPoint, const QPointF &bluePoint,
QColorSpace::TransferFunction fun, float gamma) QColorSpace::TransferFunction transferFunction, float gamma)
{ {
QColorSpacePrimaries primaries(whitePoint, redPoint, greenPoint, bluePoint); QColorSpacePrimaries primaries(whitePoint, redPoint, greenPoint, bluePoint);
if (!primaries.areValid()) { if (!primaries.areValid()) {
qWarning() << "QColorSpace attempted constructed from invalid primaries:" << whitePoint << redPoint << greenPoint << bluePoint; qWarning() << "QColorSpace attempted constructed from invalid primaries:" << whitePoint << redPoint << greenPoint << bluePoint;
return; return;
} }
d_ptr = new QColorSpacePrivate(primaries, fun, gamma); d_ptr = new QColorSpacePrivate(primaries, transferFunction, gamma);
} }
QColorSpace::~QColorSpace() = default; QColorSpace::~QColorSpace() = default;

View File

@ -84,11 +84,11 @@ public:
QColorSpace() noexcept = default; QColorSpace() noexcept = default;
QColorSpace(NamedColorSpace namedColorSpace); QColorSpace(NamedColorSpace namedColorSpace);
QColorSpace(Primaries primaries, TransferFunction fun, float gamma = 0.0f); QColorSpace(Primaries primaries, TransferFunction transferFunction, float gamma = 0.0f);
QColorSpace(Primaries primaries, float gamma); QColorSpace(Primaries primaries, float gamma);
QColorSpace(const QPointF &whitePoint, const QPointF &redPoint, QColorSpace(const QPointF &whitePoint, const QPointF &redPoint,
const QPointF &greenPoint, const QPointF &bluePoint, const QPointF &greenPoint, const QPointF &bluePoint,
TransferFunction fun, float gamma = 0.0f); TransferFunction transferFunction, float gamma = 0.0f);
~QColorSpace(); ~QColorSpace();
QColorSpace(const QColorSpace &colorSpace) noexcept; QColorSpace(const QColorSpace &colorSpace) noexcept;

View File

@ -91,8 +91,8 @@ class QColorSpacePrivate : public QSharedData
public: public:
QColorSpacePrivate(); QColorSpacePrivate();
QColorSpacePrivate(QColorSpace::NamedColorSpace namedColorSpace); QColorSpacePrivate(QColorSpace::NamedColorSpace namedColorSpace);
QColorSpacePrivate(QColorSpace::Primaries primaries, QColorSpace::TransferFunction fun, float gamma); QColorSpacePrivate(QColorSpace::Primaries primaries, QColorSpace::TransferFunction transferFunction, float gamma);
QColorSpacePrivate(const QColorSpacePrimaries &primaries, QColorSpace::TransferFunction fun, float gamma); QColorSpacePrivate(const QColorSpacePrimaries &primaries, QColorSpace::TransferFunction transferFunction, float gamma);
QColorSpacePrivate(const QColorSpacePrivate &other) = default; QColorSpacePrivate(const QColorSpacePrivate &other) = default;
static const QColorSpacePrivate *get(const QColorSpace &colorSpace) static const QColorSpacePrivate *get(const QColorSpace &colorSpace)