<table><tr><td style="">zzag created this revision.<br />zzag added a reviewer: KWin.<br />Herald added a project: KWin.<br />Herald added a subscriber: kwin.<br />zzag requested review of this revision.
</td><a style="text-decoration: none; padding: 4px 8px; margin: 0 8px 8px; float: right; color: #464C5C; font-weight: bold; border-radius: 3px; background-color: #F7F7F9; background-image: linear-gradient(to bottom,#fff,#f1f0f1); display: inline-block; border: 1px solid rgba(71,87,120,.2);" href="https://phabricator.kde.org/D22812">View Revision</a></tr></table><br /><div><strong>REVISION SUMMARY</strong><div><p>So far we were following a bit unique and rare doxygen comment style:</p>
<div class="remarkup-code-block" style="margin: 12px 0;" data-code-lang="text" data-sigil="remarkup-code-block"><pre class="remarkup-code" style="font: 11px/15px "Menlo", "Consolas", "Monaco", monospace; padding: 12px; margin: 0; background: rgba(71, 87, 120, 0.08);">/**
* Contents of the comment.
**/</pre></div>
<p>Doxygen comments with this style look balanced and neat, but many people<br />
that contribute to KWin don't follow this style. Instead, they prefer<br />
more traditional doxygen comment style, i.e.</p>
<div class="remarkup-code-block" style="margin: 12px 0;" data-code-lang="text" data-sigil="remarkup-code-block"><pre class="remarkup-code" style="font: 11px/15px "Menlo", "Consolas", "Monaco", monospace; padding: 12px; margin: 0; background: rgba(71, 87, 120, 0.08);">/**
* Contents of the comment.
*/</pre></div>
<p>Reviewing such changes has been a bit frustrating for me (so selfish!)<br />
and for other contributors.</p>
<p>This change switches doxygen comment style in KWin to a more traditional<br />
style. The main reason for doing this is to make code review process easier<br />
for new contributors as well us.</p></div></div><br /><div><strong>REPOSITORY</strong><div><div>R108 KWin</div></div></div><br /><div><strong>BRANCH</strong><div><div>fix-doxygen-comment-style</div></div></div><br /><div><strong>REVISION DETAIL</strong><div><a href="https://phabricator.kde.org/D22812">https://phabricator.kde.org/D22812</a></div></div><br /><div><strong>AFFECTED FILES</strong><div><div>abstract_client.h<br />
abstract_output.h<br />
abstract_wayland_output.h<br />
activation.cpp<br />
activities.h<br />
atoms.h<br />
autotests/integration/kwin_wayland_test.h<br />
autotests/integration/no_global_shortcuts_test.cpp<br />
autotests/tabbox/test_tabbox_clientmodel.h<br />
autotests/tabbox/test_tabbox_handler.cpp<br />
autotests/test_xkb.cpp<br />
autotests/testutils.h<br />
client.cpp<br />
client.h<br />
colorcorrection/colorcorrectdbusinterface.h<br />
colorcorrection/constants.h<br />
colorcorrection/manager.h<br />
colorcorrection/suncalc.h<br />
composite.h<br />
cursor.h<br />
dbusinterface.h<br />
decorations/decorationrenderer.h<br />
deleted.h<br />
effectloader.h<br />
effects.h<br />
effects/coverswitch/coverswitch.h<br />
effects/diminactive/diminactive.cpp<br />
effects/effect_builtins.h<br />
effects/flipswitch/flipswitch.h<br />
effects/invert/invert.h<br />
effects/kscreen/kscreen.cpp<br />
effects/lookingglass/lookingglass.h<br />
effects/presentwindows/presentwindows.h<br />
effects/screenshot/screenshot.h<br />
effects/slide/slide.cpp<br />
effects/wobblywindows/wobblywindows.h<br />
events.cpp<br />
focuschain.h<br />
geometry.cpp<br />
gestures.h<br />
globalshortcuts.h<br />
group.cpp<br />
input.cpp<br />
input.h<br />
input_event_spy.h<br />
kcmkwin/common/effectsmodel.h<br />
kcmkwin/kwindesktop/desktopsmodel.h<br />
kcmkwin/kwinscripts/module.h<br />
kcmkwin/kwintabbox/layoutpreview.h<br />
keyboard_input.h<br />
layers.cpp<br />
libinput/connection.cpp<br />
libinput/connection.h<br />
libinput/context.h<br />
libinput/device.h<br />
libkwineffects/anidata_p.h<br />
libkwineffects/kwinanimationeffect.h<br />
libkwineffects/kwineffects.h<br />
libkwineffects/kwinglobals.h<br />
libkwineffects/kwinglplatform.h<br />
libkwineffects/kwingltexture.h<br />
libkwineffects/kwinglutils.h<br />
libkwineffects/kwinxrenderutils.h<br />
logind.h<br />
main.h<br />
netinfo.h<br />
options.h<br />
orientation_sensor.h<br />
outline.h<br />
outputscreens.h<br />
placement.cpp<br />
placement.h<br />
platform.h<br />
platformsupport/scenes/opengl/backend.h<br />
platformsupport/scenes/opengl/swap_profiler.h<br />
platformsupport/scenes/qpainter/backend.h<br />
plugins/kdecorations/aurorae/src/aurorae.cpp<br />
plugins/kdecorations/aurorae/src/colorhelper.h<br />
plugins/kdecorations/aurorae/src/decorationoptions.h<br />
plugins/kdecorations/aurorae/src/lib/auroraetheme.h<br />
plugins/kdecorations/aurorae/themes/plastik/code/plastikbutton.h<br />
plugins/platforms/drm/drm_backend.h<br />
plugins/platforms/drm/edid.h<br />
plugins/platforms/drm/egl_gbm_backend.h<br />
plugins/platforms/drm/egl_stream_backend.h<br />
plugins/platforms/fbdev/fb_backend.h<br />
plugins/platforms/virtual/egl_gbm_backend.h<br />
plugins/platforms/wayland/egl_wayland_backend.h<br />
plugins/platforms/x11/common/eglonxbackend.h<br />
plugins/platforms/x11/standalone/edge.h<br />
plugins/platforms/x11/standalone/glxbackend.h<br />
plugins/platforms/x11/standalone/x11_output.h<br />
plugins/platforms/x11/standalone/x11_platform.h<br />
plugins/platforms/x11/standalone/x11cursor.h<br />
plugins/platforms/x11/windowed/egl_x11_backend.h<br />
plugins/platforms/x11/windowed/x11windowed_output.h<br />
plugins/scenes/opengl/scene_opengl.cpp<br />
plugins/scenes/opengl/scene_opengl.h<br />
plugins/scenes/xrender/scene_xrender.h<br />
pointer_input.h<br />
scene.h<br />
screenedge.h<br />
screens.h<br />
scripting/dbuscall.h<br />
scripting/meta.cpp<br />
scripting/meta.h<br />
scripting/screenedgeitem.h<br />
scripting/scriptedeffect.h<br />
scripting/scripting.h<br />
scripting/scripting_model.h<br />
scripting/scriptingutils.h<br />
scripting/workspace_wrapper.h<br />
shadow.h<br />
shell_client.h<br />
sm.cpp<br />
tabbox/clientmodel.h<br />
tabbox/desktopchain.h<br />
tabbox/desktopmodel.h<br />
tabbox/switcheritem.h<br />
tabbox/tabbox.cpp<br />
tabbox/tabbox.h<br />
tabbox/tabboxconfig.h<br />
tabbox/tabboxhandler.cpp<br />
tabbox/tabboxhandler.h<br />
tabgroup.h<br />
toplevel.cpp<br />
toplevel.h<br />
touch_input.h<br />
useractions.cpp<br />
useractions.h<br />
utils.h<br />
virtualdesktops.h<br />
wayland_server.h<br />
workspace.cpp<br />
workspace.h<br />
x11eventfilter.h<br />
xcbutils.h<br />
xkb.h<br />
xwl/clipboard.h<br />
xwl/databridge.h<br />
xwl/dnd.h<br />
xwl/drag.h<br />
xwl/selection.h<br />
xwl/selection_source.h<br />
xwl/transfer.h</div></div></div><br /><div><strong>To: </strong>zzag, KWin<br /><strong>Cc: </strong>kwin, LeGast00n, fmonteiro, sbergeron, jraleigh, fbampaloukas, GB_2, mkulinski, ragreen, jackyalcine, Pitel, iodelay, crozbo, bwowk, ZrenBot, ngraham, alexeymin, himcesjf, lesliezhai, ali-mohamed, hardening, romangg, jensreuterberg, abetts, sebas, apol, mart<br /></div>