Mentions légales du service

Skip to content
Snippets Groups Projects

Add scripts to to automatically update headers in files

Merged ORDRONNEAU Camille requested to merge cordronn/vite:copyright into master

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.

Merge request reports

Merge request pipeline #1008362 passed

Merge request pipeline passed for 2cc0848c

Merged by Philippe SWARTVAGHERPhilippe SWARTVAGHER 1 year ago (Jul 17, 2024 2:46pm UTC)

Loading

Pipeline #1008505 passed

Pipeline passed for 8507a25d on master

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Philippe SWARTVAGHER
  • Philippe SWARTVAGHER
  • Philippe SWARTVAGHER
  • Philippe SWARTVAGHER
  • Philippe SWARTVAGHER
  • Philippe SWARTVAGHER requested changes

    requested changes

  • ORDRONNEAU Camille marked this merge request as draft

    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.

    Edited by Mathieu Faverge
  • Mathieu Faverge
  • Mathieu Faverge
  • Mathieu Faverge
  • Mathieu Faverge
  • Mathieu Faverge
  • Mathieu Faverge
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading