fix files tags headers

[BazookaJoe1900]

Solved Problem

many files has wrong file tag on their header description.

Solution

I wrote script to find and fix the files

[BazookaJoe1900]

• I have only searched for c, cpp, h and hpp files
• I have only fixed tag look like @file
• I have only fixed the main repo

if there is need to expend the script, tell me

[dagar]

How about eliminating them instead? I can't imagine these actually provide value given how wrong they frequently are.

I would also propose dropping per file author tags as well, that's what git blame is for.

FYI @bresch

[BazookaJoe1900]

I actually like the file name on the file it self. when it correct, it helps when you try to search the file references.
meaning, if I want to find where xxx.h is used, it help to see xxx.h too on the search results.

about the authors names, it issue of credit, I thinks.

[BazookaJoe1900]

@dagar any reason not to merge it? there is need to change anything?

[bresch]

I would also propose dropping per file author tags as well, that's what git blame is for.

I agree 100% https://youtube.com/clip/UgkxFrPo30esfK5g9chSNaljU-IMqmZrqVUR?si=R5nxZNwefYnWGVja

[BazookaJoe1900]

@bresch what do you think about the file name? should we leave them? I prefer to keep, like I said it helps me to when I search for file references, to see the file itself on the search results

[dakejahl]

@BazookaJoe1900 if you're using sublime text or vscode you can use ctrl + p to search for file names

[BazookaJoe1900]

the original pr meant to fix the errors tags.
I think that merging the current pr is valid, and wider change of the files header can be done on another pr.

I am without a firm opinion about the author tag. but it can be done after decision will be made about 'new' header format.
who should decide that? How about poll?

BTW
I checked the option of changing the authors tags, which is more complicated, because there are different syntax of this, for example:

PX4-Autopilot/platforms/nuttx/NuttX/Make.defs.in

Line 5 in e4dd3f2

# Author: Gregory Nutt <[email protected]>

on some places the name and the 'author' are mixed with the copyright:

PX4-Autopilot/boards/mro/x21/nuttx-config/include/board.h

Lines 5 to 6 in e4dd3f2

	* Copyright (C) 2009, 2016 Gregory Nutt. All rights reserved.
	* Authors: Gregory Nutt <[email protected]>

there are some 'inline' notes:

PX4-Autopilot/src/lib/geo/geo.cpp

Line 216 in e4dd3f2

// Additional functions - @author Doug Weibel <[email protected]>

I can 'clear' only the basic ones like this one:

PX4-Autopilot/src/modules/mc_att_control/mc_att_control_main.cpp

Lines 38 to 45 in e4dd3f2

	* @author Lorenz Meier <[email protected]>
	* @author Anton Babushkin <[email protected]>
	* @author Sander Smeets <[email protected]>
	* @author Matthias Grob <[email protected]>
	* @author Beat Küng <[email protected]>
	*
	*/

[bresch]

You could leave the file names if you find them useful. The problem is -as shown by this PR- ppl tend to copy-paste the header from another file or change the name of the file and often forget to update it.

Removing the author names starting with @author would already be useful, yes. Feel free to do another PR for that.