D22812: Use more traditional doxygen style

Vlad Zagorodniy <[email protected]>
Newsgroups gmane.comp.kde.devel.kwin
Message-ID <[email protected]>
zzag created this revision.
zzag added a reviewer: KWin.
Herald added a project: KWin.
Herald added a subscriber: kwin.
zzag requested review of this revision.

REVISION SUMMARY
  So far we were following a bit unique and rare doxygen comment style:
  
    /**
     * Contents of the comment.
     **/
  
  Doxygen comments with this style look balanced and neat, but many people
  that contribute to KWin don't follow this style. Instead, they prefer
  more traditional doxygen comment style, i.e.
  
    /**
     * Contents of the comment.
     */
  
  Reviewing such changes has been a bit frustrating for me (so selfish!)
  and for other contributors.
  
  This change switches doxygen comment style in KWin to a more traditional
  style. The main reason for doing this is to make code review process easier
  for new contributors as well us.

REPOSITORY
  R108 KWin

BRANCH
  fix-doxygen-comment-style

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

AFFECTED FILES
  abstract_client.h
  abstract_output.h
  abstract_wayland_output.h
  activation.cpp
  activities.h
  atoms.h
  autotests/integration/kwin_wayland_test.h
  autotests/integration/no_global_shortcuts_test.cpp
  autotests/tabbox/test_tabbox_clientmodel.h
  autotests/tabbox/test_tabbox_handler.cpp
  autotests/test_xkb.cpp
  autotests/testutils.h
  client.cpp
  client.h
  colorcorrection/colorcorrectdbusinterface.h
  colorcorrection/constants.h
  colorcorrection/manager.h
  colorcorrection/suncalc.h
  composite.h
  cursor.h
  dbusinterface.h
  decorations/decorationrenderer.h
  deleted.h
  effectloader.h
  effects.h
  effects/coverswitch/coverswitch.h
  effects/diminactive/diminactive.cpp
  effects/effect_builtins.h
  effects/flipswitch/flipswitch.h
  effects/invert/invert.h
  effects/kscreen/kscreen.cpp
  effects/lookingglass/lookingglass.h
  effects/presentwindows/presentwindows.h
  effects/screenshot/screenshot.h
  effects/slide/slide.cpp
  effects/wobblywindows/wobblywindows.h
  events.cpp
  focuschain.h
  geometry.cpp
  gestures.h
  globalshortcuts.h
  group.cpp
  input.cpp
  input.h
  input_event_spy.h
  kcmkwin/common/effectsmodel.h
  kcmkwin/kwindesktop/desktopsmodel.h
  kcmkwin/kwinscripts/module.h
  kcmkwin/kwintabbox/layoutpreview.h
  keyboard_input.h
  layers.cpp
  libinput/connection.cpp
  libinput/connection.h
  libinput/context.h
  libinput/device.h
  libkwineffects/anidata_p.h
  libkwineffects/kwinanimationeffect.h
  libkwineffects/kwineffects.h
  libkwineffects/kwinglobals.h
  libkwineffects/kwinglplatform.h
  libkwineffects/kwingltexture.h
  libkwineffects/kwinglutils.h
  libkwineffects/kwinxrenderutils.h
  logind.h
  main.h
  netinfo.h
  options.h
  orientation_sensor.h
  outline.h
  outputscreens.h
  placement.cpp
  placement.h
  platform.h
  platformsupport/scenes/opengl/backend.h
  platformsupport/scenes/opengl/swap_profiler.h
  platformsupport/scenes/qpainter/backend.h
  plugins/kdecorations/aurorae/src/aurorae.cpp
  plugins/kdecorations/aurorae/src/colorhelper.h
  plugins/kdecorations/aurorae/src/decorationoptions.h
  plugins/kdecorations/aurorae/src/lib/auroraetheme.h
  plugins/kdecorations/aurorae/themes/plastik/code/plastikbutton.h
  plugins/platforms/drm/drm_backend.h
  plugins/platforms/drm/edid.h
  plugins/platforms/drm/egl_gbm_backend.h
  plugins/platforms/drm/egl_stream_backend.h
  plugins/platforms/fbdev/fb_backend.h
  plugins/platforms/virtual/egl_gbm_backend.h
  plugins/platforms/wayland/egl_wayland_backend.h
  plugins/platforms/x11/common/eglonxbackend.h
  plugins/platforms/x11/standalone/edge.h
  plugins/platforms/x11/standalone/glxbackend.h
  plugins/platforms/x11/standalone/x11_output.h
  plugins/platforms/x11/standalone/x11_platform.h
  plugins/platforms/x11/standalone/x11cursor.h
  plugins/platforms/x11/windowed/egl_x11_backend.h
  plugins/platforms/x11/windowed/x11windowed_output.h
  plugins/scenes/opengl/scene_opengl.cpp
  plugins/scenes/opengl/scene_opengl.h
  plugins/scenes/xrender/scene_xrender.h
  pointer_input.h
  scene.h
  screenedge.h
  screens.h
  scripting/dbuscall.h
  scripting/meta.cpp
  scripting/meta.h
  scripting/screenedgeitem.h
  scripting/scriptedeffect.h
  scripting/scripting.h
  scripting/scripting_model.h
  scripting/scriptingutils.h
  scripting/workspace_wrapper.h
  shadow.h
  shell_client.h
  sm.cpp
  tabbox/clientmodel.h
  tabbox/desktopchain.h
  tabbox/desktopmodel.h
  tabbox/switcheritem.h
  tabbox/tabbox.cpp
  tabbox/tabbox.h
  tabbox/tabboxconfig.h
  tabbox/tabboxhandler.cpp
  tabbox/tabboxhandler.h
  tabgroup.h
  toplevel.cpp
  toplevel.h
  touch_input.h
  useractions.cpp
  useractions.h
  utils.h
  virtualdesktops.h
  wayland_server.h
  workspace.cpp
  workspace.h
  x11eventfilter.h
  xcbutils.h
  xkb.h
  xwl/clipboard.h
  xwl/databridge.h
  xwl/dnd.h
  xwl/drag.h
  xwl/selection.h
  xwl/selection_source.h
  xwl/transfer.h

To: zzag, #kwin
Cc: 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
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.