D17832: [libkwineffects] Overhaul AnimationEffect's documentation

graesslin added inline comments.

INLINE COMMENTS

> kwinanimationeffect.h:168
>      /**
> -     * Whenever you intend to connect to the EffectsHandler::windowClosed() signal, do so when reimplementing the constructor.
> -     * Do *not* add private slots named _windowClosed( EffectWindow* w ) or _windowDeleted( EffectWindow* w ) !!
> +     * Constructs the animation effect.
> +     *

Constructs the AnimationEffect

> kwinanimationeffect.h:171
> +     * Whenever you intend to connect to the EffectsHandler::windowClosed() signal,
> +     * do so when reimplementing the constructor. Do *not* add private slots named
> +     * _windowClosed(EffectWindow *w) or _windowDeleted(EffectWindow *w)!

the emphasis on not does not look like valid doxygen syntax

REPOSITORY
  R108 KWin

REVISION DETAIL
  https://phabricator.kde.org/D17832

To: zzag, #kwin
Cc: graesslin, davidedmundson, kwin, GB_2, mkulinski, ragreen, jackyalcine, Pitel, iodelay, bwowk, ZrenBot, ngraham, lesliezhai, ali-mohamed, hardening, jensreuterberg, abetts, sebas, apol, mart