Blocs de licence dans le code

J’ai passé une petite journée, hier, à modifier tous les fichiers sources (PHP) de :

Pour passer d’un truc qui ressemble à (mais pas toujours, j’ai trouvé des trucs assez différents) :

<?php
# -- BEGIN LICENSE BLOCK ---------------------------------------
#
# This file is part of Dotclear 2.
#
# Copyright (c) 2003-2013 Olivier Meunier & Association Dotclear
# Licensed under the GPL version 2.0 license.
# See LICENSE file or
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
#
# -- END LICENSE BLOCK -----------------------------------------

À un plus exploitable (en tout cas par Doxygen qui permet de générer une documentation à partir des commentaires présents dans les sources) :

<?php
/**
 * @package Dotclear
 * @subpackage Backend
 *
 * @copyright Olivier Meunier & Association Dotclear
 * @copyright GPL-2.0-only
 */

En adaptant bien sur :

  • le nom du @package : Dotclear pour Dotclear, les thèmes et les plugins, Clearbricks pour Clearbricks
  • Le @subpackage : Core, Admin, Public, Themes, Plugins côté Dotclear, ou plus spécialisé côté Clearbricks
  • J’ai rajouté le ou les auteurs si nécessaire (avec une ou plusieurs lignes @author)
  • Le @copyright avec les auteurs si besoin ; notez au passage la disparition de la mention de l’année ou des années (une chose de moins à maintenir)
  • Tout est passé en GPL-2.0-only côté Clearbricks et Dotclear, mes plugins et thèmes restants en GPL-2.0 ; faut que je vérifie la compatibilité au passage, je ne suis pas sûr que ce soit pertinent

Exemple pour un de mes thèmes :

<?php
/**
 * @brief zh2, a theme for Dotclear 2
 *
 * @package Dotclear
 * @subpackage Themes
 *
 * @copyright Franck Paul (carnet.franck.paul@gmail.com)
 * @copyright GPL-2.0
 */

Ou encore pour un de mes plugins :

<?php
/**
 * @brief hljs, a plugin for Dotclear 2
 *
 * @package Dotclear
 * @subpackage Plugins
 *
 * @author Franck Paul and contributors
 *
 * @copyright Franck Paul carnet.franck.paul@gmail.com
 * @copyright GPL-2.0
 */

C’est beaucoup plus clair et carré ainsi.

Ajouter un commentaire

Les commentaires peuvent être formatés en utilisant une syntaxe wiki simplifiée.

Ajouter un rétrolien

URL de rétrolien : https://open-time.net/trackback/13720

Haut de page