Use more traditional doxygen style
ClosedPublic

Authored by zzag on Jul 29 2019, 6:50 PM.

Details

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.

Diff Detail

Repository
R108 KWin
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
zzag created this revision.Jul 29 2019, 6:50 PM
Restricted Application added a project: KWin. · View Herald TranscriptJul 29 2019, 6:50 PM
Restricted Application added a subscriber: kwin. · View Herald Transcript
zzag requested review of this revision.Jul 29 2019, 6:50 PM
zzag added a comment.Jul 29 2019, 6:51 PM

This change was created by running git grep and piping its output to sed.

davidedmundson accepted this revision.Jul 29 2019, 6:52 PM
This revision is now accepted and ready to land.Jul 29 2019, 6:52 PM
This revision was automatically updated to reflect the committed changes.