aboutsummaryrefslogtreecommitdiffstats
path: root/src/particles/qquickparticleaffector.cpp
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2021-11-09 12:24:43 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2021-11-14 23:47:54 +0100
commitdc569a618981fb6791e08c39295e1e937b381224 (patch)
treef3dbe8075cbfbde4fc7cc707682a779766999246 /src/particles/qquickparticleaffector.cpp
parentd7c2c884cf05efefdcbdd922805e1a779ca43e29 (diff)
Doc: Fix qdoc warnings
- Comment out \instantiates entries that refer to private C++ classes - Fix clang-format and regexp warnings Change-Id: I7228538715b9d34ab39e7c0f71155be7a277116a Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/particles/qquickparticleaffector.cpp')
-rw-r--r--src/particles/qquickparticleaffector.cpp26
1 files changed, 15 insertions, 11 deletions
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp
index aefaa2c399..41314d80bd 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype Affector
- \instantiates QQuickParticleAffector
+//! \instantiates QQuickParticleAffector
\inqmlmodule QtQuick.Particles
\brief Applies alterations to the attributes of logical particles at any
point in their lifetime.
@@ -53,22 +53,26 @@ QT_BEGIN_NAMESPACE
The base Affector does not alter any attributes, but can be used to emit a signal
when a particle meets certain conditions.
- If an affector has a defined size, then it will only affect particles within its size and position on screen.
+ If an affector has a defined size, then it will only affect particles within its size and
+position on screen.
- Affectors have different performance characteristics to the other particle system elements. In particular,
- they have some simplifications to try to maintain a simulation at real-time or faster. When running a system
- with Affectors, irregular frame timings that grow too large ( > one second per frame) will cause the Affectors
- to try and cut corners with a faster but less accurate simulation. If the system has multiple affectors the order
- in which they are applied is not guaranteed, and when simulating larger time shifts they will simulate the whole
- shift each, which can lead to different results compared to smaller time shifts.
+ Affectors have different performance characteristics to the other particle system elements. In
+particular, they have some simplifications to try to maintain a simulation at real-time or faster.
+When running a system with Affectors, irregular frame timings that grow too large ( > one second per
+frame) will cause the Affectors to try and cut corners with a faster but less accurate simulation.
+If the system has multiple affectors the order in which they are applied is not guaranteed, and when
+simulating larger time shifts they will simulate the whole shift each, which can lead to different
+results compared to smaller time shifts.
- Accurate simulation for large numbers of particles (hundreds) with multiple affectors may be possible on some hardware,
- but on less capable hardware you should expect small irregularties in the simulation as simulates with worse granularity.
+ Accurate simulation for large numbers of particles (hundreds) with multiple affectors may be
+possible on some hardware, but on less capable hardware you should expect small irregularties in the
+simulation as simulates with worse granularity.
*/
/*!
\qmlproperty ParticleSystem QtQuick.Particles::Affector::system
This is the system which will be affected by the element.
- If the Affector is a direct child of a ParticleSystem, it will automatically be associated with it.
+ If the Affector is a direct child of a ParticleSystem, it will automatically be associated with
+ it.
*/
/*!
\qmlproperty list<string> QtQuick.Particles::Affector::groups