Personal tools
gvSIG Desktop
gvSIG Desktop

Cached time 11/21/13 17:00:28 Clear cache and reload

 
Document Actions

Headers

by Cèsar Ordiñana last modified 2012-03-22 09:51

Source code and other files headers

All project java source files will contain the following header:

.. code-block:: java
    
    /**
     * gvSIG. Desktop Geographic Information System.
     *
     * Copyright © 2007-2012 gvSIG Association
     *
     * This program is free software; you can redistribute it and/or
     * modify it under the terms of the GNU General Public License
     * as published by the Free Software Foundation; either version 2
     * of the License, or (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
     * MA  02110-1301, USA.
     *  
     * For any additional information, do not hesitate to contact us 
     * at info AT gvsig.com, or visit our website www.gvsig.com.
     */


In other languages source code (C, C++, etc.), as well other configuration or definition files (XML, properties, txt, etc.) the previous header must be included also, using the related comment format.

This header has been defined into the eclipse *Code Templates* configuration, so it gets included by default when a new java file is created.

To update existing files without header or with an old one, the `maven-license-plugin `_ maven plugin has been configured. That configuration is available into the `pom.xml `_ file of the *org.gvsig.maven.base.pom* project.

To update or include the previous header automatically, just call::

  mvn license:format

Take into account the previous order will modify the headers of all the maven plugin supported files. If anyone is not correcto or it is not mapped, it might be easily added to the configuration.

Yo may also validate if a project files headers are correct by calling::

  mvn license:check

View source document

View source document Get permanent link


Powered by Plone CMS, the Open Source Content Management System

This site conforms to the following standards: