Skip to content

GitLab

Commit c78d80c7 authored by malossi's avatar malossi
Browse files

Updated Emacs template files: now they provide the files defined in the LifeV... 

Updated Emacs template files: now they provide the files defined in the LifeV Development Guidelines.

Eclipse developers can instead use directly the files in the /doc/CodingGuidelines
parent a2a452b8
Hide whitespace changes
Inline Side-by-side
Templates/Makefile.am.tpl
View file @ c78d80c7
# -*- mode: makefile -*-
# -*- makefile -*-
###################################################################################################
#
# This file is part of the LifeV library
# This file is part of the LifeV Applications
# Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
#
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>ISO_DATE<<<)
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>DATE<<<)
# License Terms: GNU GPL
#
# Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
###################################################################################################
(>>>POINT<<<)
\ No newline at end of file
Templates/README
View file @ c78d80c7
# -*- mode: readme-debian -*-
# -*- makefile -*-
###################################################################################################
#
# README --- Templates for LifeV library
#
# Author(s): Christophe Prud'homme <christophe.prudhomme@epfl.ch>
# Date: 2004-09-26
#
# Copyright (C) 2004 EPFL
#
# Distributed under the GPL(GNU Public License):
# 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., 675 Mass Ave, Cambridge, MA 02139, USA.
# This file is part of the LifeV Applications
# Copyright (C) 2001-2010 EPFL, Politecnico di Milano, INRIA
#
# Author(s): Cristiano Malossi <cristiano.malossi@epfl.ch>
# Date: 12 Jan 2010
# License Terms: GNU GPL
#
###################################################################################################
LifeV developers should use primarily (x)emacs as their development
platform. This directory holds templates for newly created files in
LifeV with extension support for C++ headers/implementation, m4,
README, automake Makefiles, autotest, and doxygen.
LifeV developers which use primarily (x)emacs as their development
platform should use these template files, which are created using the default ones
defined in the "LifeV Development Guidelines".
In order to use these templates properly you should install the
template elisp package from Christoph Wedler hosted at
http://emacs-template.sourceforge.net/. It consists in one .el file.
-- Christophe Prud'homme <prudhomm@debian.org>, Sun Sep 26 15:36:34 2004
Templates/README.tpl
View file @ c78d80c7
### README.tpl --- (>>>POINT<<<)
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>ISO_DATE<<<)
#
# Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
###################################################################################################
#
# Distributed under the GPL(GNU Public License):
# 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., 675 Mass Ave, Cambridge, MA 02139, USA.
# This file is part of the LifeV Applications
# Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
#
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>DATE<<<)
# License Terms: GNU GPL
#
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
###################################################################################################
(>>>POINT<<<)
\ No newline at end of file
Templates/TEMPLATE.am.tpl
View file @ c78d80c7
# -*- mode: makefile -*-
# -*- makefile -*-
###################################################################################################
#
# This file is part of the LifeV library
# This file is part of the LifeV Applications
# Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
#
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>ISO_DATE<<<)
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>DATE<<<)
# License Terms: GNU GPL
#
# Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
###################################################################################################
(>>>POINT<<<)
\ No newline at end of file
Templates/TEMPLATE.at.tpl
View file @ c78d80c7
# -*- mode: m4 -*-
###################################################################################################
#
# This file is part of the LifeV library
# This file is part of the LifeV Applications
# Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
#
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>ISO_DATE<<<)
# Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# Date: (>>>DATE<<<)
# License Terms: GNU GPL
#
# Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# \file (>>>FILE<<<)
# \author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
# \date (>>>ISO_DATE<<<)
#
###################################################################################################
AT_SETUP([test_NameOfTheTest]) #Name of the test
AT_KEYWORDS([])
AT_DATA([data.txt], #Data file
[[
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
# Place here the content of the GetPot data file for the night test.
]])
AT_CHECK([ln -sf ../../data/mesh/inria/Mesh &&
mpirun -n 1 ../../test_TemplateTest/test_TemplateTest -c],[0],[ignore],[ignore])
AT_CLEANUP([FilesCreatedByTheTest1.txt
FilesCreatedByTheTest2.txt
...
]) # Files to be removed at the end of the test
Templates/TEMPLATE.cpp.tpl
View file @ c78d80c7
/* -*- mode: c++ -*-
//@HEADER
/*
************************************************************************
This file is part of the LifeV library
This file is part of the LifeV Applications.
Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
Date: (>>>ISO_DATE<<<)
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
************************************************************************
*/
//@HEADER
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
/*!
@file
@brief A short description of the file content
This library 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
Lesser General Public License for more details.
@author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
@date (>>>DATE<<<)
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
\file (>>>FILE<<<)
\author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
\date (>>>ISO_DATE<<<)
A more detailed description of the file (if necessary)
*/
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
#include <(>>>FILE_SANS<<<).hpp>
namespace LifeV {
// ===================================================
// Constructors & Destructor
// ===================================================
(>>>FILE_SANS<<<)::(>>>FILE_SANS<<<)() :
M_variableOne (),
M_variableTwo ()
{
}
(>>>FILE_SANS<<<)::(>>>FILE_SANS<<<)( first_Type& variableOne,
second_Type& variableTwo ) :
M_variableOne ( variableOne ),
M_variableTwo ( variableTwo )
{
}
(>>>FILE_SANS<<<)::(>>>FILE_SANS<<<)( const TemplateClass& T ) :
M_variableOne ( T.M_variableOne ),
M_variableTwo ( T.M_variableTwo )
{
}
(>>>FILE_SANS<<<)::~(>>>FILE_SANS<<<)()
{
}
// ===================================================
// Operators
// ===================================================
(>>>FILE_SANS<<<)&
(>>>FILE_SANS<<<)::operator=( const (>>>FILE_SANS<<<)& T )
{
if ( this != &T )
{
M_variableOne = T.M_variableOne;
M_variableTwo = T.M_variableTwo;
}
return *this;
}
// ===================================================
// Methods
// ===================================================
void
(>>>FILE_SANS<<<)::methodOne( first_Type& inputVariableOne,
second_Type& inputVariableTwo )
{
//Do something
}
void
(>>>FILE_SANS<<<)::methodTwo()
{
}
void
(>>>FILE_SANS<<<)::showMe( std::ostream& output ) const
{
output << "TemplateClass::showMe()" << std::endl;
output << "Variable one: " << M_variableOne << std::endl;
output << "Variable two: " << M_variableTwo << std::endl;
}
// ===================================================
// Set Methods
// ===================================================
void
(>>>FILE_SANS<<<)::setVariableOne( const first_Type& variableOne )
{
M_variableOne = variableOne;
}
// ===================================================
// Get Methods
// ===================================================
const (>>>FILE_SANS<<<)::first_Type&
(>>>FILE_SANS<<<)::variableOne() const
{
return M_variableOne;
}
// ===================================================
// Private Methods
// ===================================================
void
(>>>FILE_SANS<<<)::privateMethodOne()
{
//Do something ..
}
} // Namespace LifeV
Templates/TEMPLATE.dox.tpl
View file @ c78d80c7
/* -*- mode: c++ -*-
This file is part of the LifeV library
Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
Date: (>>>ISO_DATE<<<)
Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
\file (>>>FILE_SANS<<<)
\author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
\date (>>>ISO_DATE<<<)
\version 1.0
*/
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
/*!
@mainpage Title
(>>>POINT<<<)
*/
Templates/TEMPLATE.hpp.tpl
View file @ c78d80c7
/* -*- mode: c++ -*-
//@HEADER
/*
************************************************************************
This file is part of the LifeV library
This file is part of the LifeV Applications.
Copyright (C) 2001-(>>>YEAR<<<) EPFL, Politecnico di Milano, INRIA
Author(s): (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
Date: (>>>ISO_DATE<<<)
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
Copyright (C) (>>>YEAR<<<) (>>>ORG<<<)
************************************************************************
*/
//@HEADER
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
/*!
@file
@brief A short description of the file content
This library 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
Lesser General Public License for more details.
@author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
@date (>>>DATE<<<)
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
\file (>>>FILE<<<)
\author (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
\date (>>>ISO_DATE<<<)
A more detailed description of the file (if necessary)
*/
#ifndef (>>>FILE_UPCASE<<<)_H
#define (>>>FILE_UPCASE<<<)_H 1
#include <life/lifecore/life.hpp>
namespace LifeV {
//! (>>>FILE_SANS<<<) - Short description of the class
/*!
@author (>>>USER_NAME<<<)
@see Reference to papers (if available)
Here write a long and detailed description of the class.
For this purpose you can use a lot of standard HTML code.
Here there is a list with some useful examples:
For bold text use: <b>BOLD TEXT</b>
For empatyze a word type @e followed by the word
For verbatim a word type @c followed by the word
For vertical space (empty lines) use: <br>
For creating list type:
<ol>
<li> First element of the enumerated list
<ul>
<li> First element of the dotted sublist.
<li> Second element of the dotted sublist
</ul>
<li> Second element of the enumerated list
<li> Third element of the enumerated list
</ol>
For writing a warning type: @warning followed by the description
of the warning
It is possible to use a lot of other standard HTML commands.
Visit http://www.stack.nl/~dimitri/doxygen/htmlcmds.html for
a detailed list.
For any other kind of information visit www.doxygen.org.
*/
(>>>POINT<<<)
>>>TEMPLATE-DEFINITION-SECTION<<<
("ORG" "Your Organization: " "" "" "EPFL, INRIA, Politecnico di Milano")
class (>>>FILE_SANS<<<)
{
public:
//! @name Public Types
//@{
/*! @enum listOfTemplatesOptions
Description of the purpose of the enumerator list.
*/
enum listOfTemplatesOptions
{
options1, /*!< This options means ... */
options2, /*!< This options means ... */
options3 /*!< This options means ... */
};
typedef int first_Type;
typedef double second_Type;
//@}
//! @name Constructor & Destructor
//@{
//! Empty Constructor
(>>>FILE_SANS<<<)();
//! Short description of the constructor
/*!
Add more details about the constructor.
NOTE: short description is automatically added before this part.
@param VariableOne Description of the first variable
@param VariableTwo Description of the second variable
*/
(>>>FILE_SANS<<<)( first_Type& VariableOne, second_Type& VariableTwo );
//! Copy constructor
/*!
Add more details about the copy constructor.
NOTE: short description is automatically added before this part.
@param T (>>>FILE_SANS<<<)
*/
(>>>FILE_SANS<<<)( const (>>>FILE_SANS<<<)& T );
//! Destructor
~(>>>FILE_SANS<<<)();
//@}
//! @name Methods
//@{
//! Short description of this method
/*!
Add more details about the method.
NOTE: short description is automatically added before this part.
@param inputVariableOne Description of the first input variable
@param inputVariableTwo Description of the second input variable
*/
void methodOne( first_Type& inputVariableOne, second_Type& inputVariableTwo );
//! Short description of this method
/*!
Add more details about the method.
NOTE: short description is automatically added before this part.
*/
void methodTwo();
//! Display general information about the content of the class
/*!
List of things displayed in the class
@param output specify the output format (std::cout by default)
*/
void showMe( std::ostream& output = std::cout ) const;
//@}
//! @name Operators
//@{
//! The equivalence operator
/*!
Add more details about the method.
NOTE: short description is automatically added before this part.