Logo
Finite Element Embedded Library and Language in C++
Feel++ Feel++ on Github Feel++ on Travis-CI Feel++ on Twitter Feel++ on YouTube Feel++ community
 All Classes Namespaces Files Functions Variables Typedefs Pages
example.hpp
1 /* -*- mode: c++; coding: utf-8; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; show-trailing-whitespace: t -*- vim:fenc=utf-8:ft=tcl:et:sw=4:ts=4:sts=4
2 
3  This file is part of the Feel library
4 
5  Author(s): Christophe Prud'homme <christophe.prudhomme@feelpp.org>
6  Date: 2005-02-10
7 
8  Copyright (C) 2005,2006 EPFL
9  Copyright (C) 2007 Université Joseph Fourier (Grenoble I)
10 
11  This library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU Lesser General Public
13  License as published by the Free Software Foundation; either
14  version 3.0 of the License, or (at your option) any later version.
15 
16  This library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  Lesser General Public License for more details.
20 
21  You should have received a copy of the GNU Lesser General Public
22  License along with this library; if not, write to the Free Software
23  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25 
82 
87 
124 namespace Feel
125 {
126 
138 class Example
139 {
140 public:
141 
145 
146  Example( type1 param1, type2 param2=value2 );
147  Example();
148  virtual ~Example();
149 
151 
152 
156 
160  Example& operator=( Example const& __g );
161 
163 
164 
168 
172  type1 accessor1() const
173  {
174  return M_data1;
175  }
176 
181  type2 acessor2() const
182  {
183  return M_data2;
184  }
185 
187 
191 
195  type1 setData1( int dim )
196  {
197  M_data1 = dim;
198  }
199 
201 
202 
206 
216  type1 methode1( ptype1 parameter1, ptype2 parameter2);
217 
219 
220 private:
221 
222  // Private data wont be documented
223 
224 protected:
227 
228 };
229 
230 }
231 
232 
234 
235 // All the code between '\cond DETAIL' and '\endcond' wont be documented.
236 // Use this command to hide obsolete or useless parts.
237 
239 
240 // The following boost function wont be documented
241 BOOST_PARAMETER_FUNCTION(
242  ( typename exampletype ), // return type
243  examplefun, // 2. function name
244 
245  tag, // 3. namespace of tag types
246 
247  ( required
248  ( param, * )
249  )
250  ( optional
251  )
252 { }
253  )
type1 setData1(int dim)
set the data1
Definition: example.hpp:195
type1 methode1(ptype1 parameter1, ptype2 parameter2)
a brief description of methode1
Example & operator=(Example const &__g)
assignment operator
type2 acessor2() const
get the value of the second data
Definition: example.hpp:181
type1 accessor1() const
Definition: example.hpp:172
Brief description of the class Example.
Definition: example.hpp:138
object1
this is a short description of object1
Definition: example.hpp:226