Add scripts to to automatically update headers in files

This fixes issue #26 (closed)

Here is an example of the format of current headers :

/*
 **
 ** @file src/interface/Settings_window.cpp
 **
 **
 ** @copyright 2008-2024 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 **                      Univ. Bordeaux. All rights reserved.
 **
 **
 ** @author Augustin Degomme
 ** @author Johnny Jazeix
 ** @author Mathieu Faverge
 ** @author Camille Ordronneau
 ** @author Thibault Soucarre
 **
 **
 **
 **
 **
 ** @date 2024-07-15
 */

Headers update with commited changes, so two commits are necessary to update the header of a file. First the update take into account only the changes done to the file Then, because the header was changed, a second update is needed

File headers don't update if the date of the last changes is the same as the date in the @date field.

added 2 commits

• 26415c6f - Add and Update file headers
• 312e6b0b - Update headers with last commit

Compare with previous version

marked this merge request as draft

marked this merge request as ready

Can you add the execution of check_headers.sh to .gitlab-ci.yml, please?

requested changes

marked this merge request as draft

Just in case, the example you give in the header of this MR contains too many empty lines. It should be:

/**
 *
 * @file src/interface/Settings_window.cpp
 *
 * @copyright 2008-2024 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
 *
 * @author Augustin Degomme
 * @author Johnny Jazeix
 * @author Mathieu Faverge
 * @author Camille Ordronneau
 * @author Thibault Soucarre
 *
 * @date 2024-07-15
 */

It should start by /** and not /* to make it a Doxygen comment, and no need for double stars on each line.

Why the last commit is not merge with the previous one ?