Overhaul doxygen comments
Concern Raised7b20e1f66f83
Actions

Authored by zzag on Feb 2 2019, 6:17 PM.

Description

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.

Reviewers: KWin, davidedmundson

Reviewed By: KWin, davidedmundson

Subscribers: kwin

Tags: KWin

Differential Revision: https://phabricator.kde.org/D18683

Details

Auditors

romangg

Committed

zzag	Feb 12 2019, 5:29 PM

Reviewer

KWin

Differential Revision

D18683: Overhaul doxygen comments

Parents

R108:31dcf51c8843: [kcmkwin/kwindecoration] Fix Get Hot New Stuff

Branches

Unknown

Tags

Unknown

zzag committed R108:7b20e1f66f83: Overhaul doxygen comments (authored by zzag).Feb 12 2019, 5:29 PM

I only saw this commit now through other review.

What's the reason for adding the superfluous second star in the last line everywhere? The Doxygen documentation only shows examples with one star in the last line: http://www.doxygen.nl/manual/docblocks.html

And looking over the diff it seems most comments in KWin were before also in this format:

/**
 *
 */

This commit now has outstanding concerns.Feb 19 2019, 9:49 AM

Changes (80)

				Path	Packages
	M			abstract_client.h
	M			abstract_output.h
	M			activation.cpp
	M			activities.h
	M			client.cpp
	M			client.h
	M			colorcorrection/constants.h
	M			composite.h
	M			cursor.h
	M			dbusinterface.h
	M			effectloader.h
	M			effects.h
	M			effects/slide/slide.cpp
	M			events.cpp
	M			geometry.cpp
	M			globalshortcuts.h
	M			group.cpp
	M			input.h
	M			kcmkwin/kwinscripts/module.h
	M			kcmkwin/kwintabbox/layoutpreview.h
	M			keyboard_input.h
	M			layers.cpp
	M			libkwineffects/anidata_p.h
	M			libkwineffects/kwineffects.h
	M			libkwineffects/kwinglobals.h
	M			libkwineffects/kwinglplatform.h
	M			libkwineffects/kwingltexture.h
	M			libkwineffects/kwinglutils.h
	M			libkwineffects/kwinxrenderutils.h
	M			main.h
	M			netinfo.h
	M			options.h
	M			outline.h
	M			placement.cpp
	M			placement.h
	M			platform.h
	M			platformsupport/scenes/opengl/backend.h
	M			platformsupport/scenes/qpainter/backend.h
	M			plugins/kdecorations/aurorae/src/colorhelper.h
	M			plugins/kdecorations/aurorae/src/decorationoptions.h
	M			plugins/kdecorations/aurorae/src/lib/auroraetheme.h
	M			plugins/kdecorations/aurorae/themes/plastik/code/plastikbutton.h
	M			plugins/platforms/drm/drm_backend.h
	M			plugins/platforms/drm/egl_gbm_backend.h
	M			plugins/platforms/wayland/wayland_backend.h
	M			plugins/platforms/x11/standalone/x11cursor.h
	M			plugins/scenes/opengl/scene_opengl.cpp
	M			plugins/scenes/xrender/scene_xrender.h
	M			pointer_input.h
	M			scene.h
	M			screenedge.h
	M			screens.h
	M			scripting/dbuscall.h
	M			scripting/meta.h
	M			scripting/screenedgeitem.h
	M			scripting/scriptedeffect.h
	M			scripting/scripting.h
	M			scripting/scripting_model.h
	M			scripting/workspace_wrapper.h
	M			shell_client.h
	M			sm.cpp
	M			tabbox/clientmodel.h
	M			tabbox/desktopmodel.h
	M			tabbox/switcheritem.h
	M			tabbox/tabbox.cpp
	M			tabbox/tabbox.h
	M			tabbox/tabboxconfig.h
	M			tabbox/tabboxhandler.cpp
	M			tabbox/tabboxhandler.h
	M			tabgroup.h
	M			toplevel.cpp
	M			toplevel.h
	M			useractions.cpp
	M			utils.h
	M			virtualdesktops.h
	M			wayland_server.h
	M			workspace.cpp
	M			workspace.h
	M			x11eventfilter.h
	M			xcbutils.h