Duplicating routine/class name in documentation comment.

I understand that current coding guidelines are strictly against
duplicating routine/class name in documentation comment though old
code is written that way, but, I could still see this kind of
duplication in few recent check-ins, after I got this review comment
for one of my recent patches. So, I am curious to send this mail.

It is generally discouraged because duplication causes documentation to go out of date whenever the function/class name changes: it’s a drag to remember to update the comment and many times people don’t.

Instead, it’s simply easier to let Doxygen correctly assess which class/function the comment targets. It just works!

– Matthieu

I understand that current coding guidelines are strictly against
duplicating routine/class name in documentation comment though old
code is written that way, but, I could still see this kind of
duplication in few recent check-ins, after I got this review comment
for one of my recent patches. So, I am curious to send this mail.

Essentially, old habits die hard. ;]

It will take time for those with long-established habits of writing
doxygen comments to retrain themselves, and some code even though it
is submitted recently, dates from before the rule went into effect.

That said, if you see code getting submitted with this style of
doxygen comment, feel free to leave a note to remind the author to
clean it up in favor of newly advised comment style.