Differential D18683

Overhaul doxygen comments
ClosedPublic
Actions

Authored by zzag on Feb 2 2019, 7:00 PM.

Details

Reviewers

davidedmundson

Group Reviewers

KWin

Commits

R108:7b20e1f66f83: Overhaul doxygen comments

Summary

We have a mix of different doxygen comment styles, e.g.

/*!
  Foo bar.
 */

/**
 * Foo bar.
 */

/** Foo bar.
 */

/**
 * Foo bar.
 */

/**
 * Foo bar.
 **/

To make the code more consistent, this change updates the style of all
doxygen comments to the last one.

Test Plan

Compiles.

Diff Detail

Repository

R108 KWin

Branch

uniform-doxygen-comments

Lint

Lint OK

Unit

No Unit Test Coverage

Build Status

Buildable 7795
Build 7813: arc lint + arc unit

zzag created this revision.Feb 2 2019, 7:00 PM

Restricted Application added a project: KWin. · View Herald TranscriptFeb 2 2019, 7:00 PM

Restricted Application added a subscriber: kwin. · View Herald Transcript

zzag requested review of this revision.Feb 2 2019, 7:00 PM

Harbormaster completed remote builds in B7795: Diff 50741.Feb 2 2019, 7:00 PM

update

Harbormaster completed remote builds in B7796: Diff 50742.Feb 2 2019, 7:30 PM

zzag mentioned this in D15629: [xwl] text/x-uri converter for selected X url list format targets.Feb 6 2019, 12:01 PM

davidedmundson accepted this revision.Feb 12 2019, 4:38 PM

This revision is now accepted and ready to land.Feb 12 2019, 4:38 PM

Closed by commit R108:7b20e1f66f83: Overhaul doxygen comments (authored by zzag). · Explain WhyFeb 12 2019, 5:34 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			abstract_client.h (104 lines)
M			abstract_output.h (20 lines)
M			activation.cpp (79 lines)
M			activities.h (14 lines)
M			client.h (24 lines)
M			client.cpp (50 lines)
M			colorcorrection/constants.h (5 lines)
M			composite.h (4 lines)
M			cursor.h (21 lines)
M			dbusinterface.h (4 lines)
M			effectloader.h (28 lines)
M			effects.h (2 lines)
M			effects/slide/slide.cpp (14 lines)
M			events.cpp (54 lines)
M			geometry.cpp (146 lines)
M			globalshortcuts.h (8 lines)
M			group.cpp (12 lines)
M			input.h (34 lines)
M			kcmkwin/kwinscripts/module.h (10 lines)
M			kcmkwin/kwintabbox/layoutpreview.h (2 lines)
M			keyboard_input.h (4 lines)
M			layers.cpp (28 lines)
M			libkwineffects/anidata_p.h (2 lines)
M			libkwineffects/kwineffects.h (340 lines)
M			libkwineffects/kwinglobals.h (3 lines)
M			libkwineffects/kwinglplatform.h (50 lines)
M			libkwineffects/kwingltexture.h (8 lines)
M			libkwineffects/kwinglutils.h (50 lines)
M			libkwineffects/kwinxrenderutils.h (24 lines)
M			main.h (26 lines)
M			netinfo.h (4 lines)
M			options.h (238 lines)
M			outline.h (14 lines)
M			placement.h (2 lines)
M			placement.cpp (42 lines)
M			platform.h (4 lines)
M			platformsupport/scenes/opengl/backend.h (10 lines)
M			platformsupport/scenes/qpainter/backend.h (4 lines)
M			plugins/kdecorations/aurorae/src/colorhelper.h (59 lines)
M			plugins/kdecorations/aurorae/src/decorationoptions.h (6 lines)
M			plugins/kdecorations/aurorae/src/lib/auroraetheme.h (30 lines)
M			plugins/kdecorations/aurorae/themes/plastik/code/plastikbutton.h (4 lines)
M			plugins/platforms/drm/drm_backend.h (4 lines)
M			plugins/platforms/drm/egl_gbm_backend.h (4 lines)
M			plugins/platforms/wayland/wayland_backend.h (10 lines)
M			plugins/platforms/x11/standalone/x11cursor.h (10 lines)
M			plugins/scenes/opengl/scene_opengl.cpp (6 lines)
M			plugins/scenes/xrender/scene_xrender.h (15 lines)
M			pointer_input.h (22 lines)
M			scene.h (30 lines)
M			screenedge.h (18 lines)
M			screens.h (22 lines)
M			scripting/dbuscall.h (2 lines)
M			scripting/meta.h (52 lines)
M			scripting/screenedgeitem.h (9 lines)
M			scripting/scriptedeffect.h (2 lines)
M			scripting/scripting.h (10 lines)
M			scripting/scripting_model.h (8 lines)
M			scripting/workspace_wrapper.h (4 lines)
M			shell_client.h (2 lines)
M			sm.cpp (38 lines)
M			tabbox/clientmodel.h (56 lines)
M			tabbox/desktopmodel.h (40 lines)
M			tabbox/switcheritem.h (2 lines)
M			tabbox/tabbox.h (100 lines)
M			tabbox/tabbox.cpp (91 lines)
M			tabbox/tabboxconfig.h (288 lines)
M			tabbox/tabboxhandler.h (364 lines)
M			tabbox/tabboxhandler.cpp (12 lines)
M			tabgroup.h (36 lines)
M			toplevel.h (48 lines)
M			toplevel.cpp (32 lines)
M			useractions.cpp (118 lines)
M			utils.h (7 lines)
M			virtualdesktops.h (50 lines)
M			wayland_server.h (4 lines)
M			workspace.h (32 lines)
M			workspace.cpp (14 lines)
M			x11eventfilter.h (12 lines)
M			xcbutils.h (280 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	50741	5ad797d		Feb 2 2019, 7:00 PM	★	★
Diff 2	50742	5ad797d	update	Feb 2 2019, 7:30 PM	★	★
Diff 3	51530	31dcf51	R108:7b20e1f66f83657591001f473d31555c295e5569	Feb 12 2019, 5:29 PM	★	★