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 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) 2010-2014 Feel++ Consortium
9 
10  This library is free software; you can redistribute it and/or
11  modify it under the terms of the GNU Lesser General Public
12  License as published by the Free Software Foundation; either
13  version 3.0 of the License, or (at your option) any later version.
14 
15  This library is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  Lesser General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public
21  License along with this library; if not, write to the Free Software
22  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24 
81 
86 
123 namespace Feel
124 {
125 
137 class Example
138 {
139 public:
140 
144 
145  Example( type1 param1, type2 param2=value2 );
146  Example();
147  virtual ~Example();
148 
150 
151 
155 
159  Example& operator=( Example const& __g );
160 
162 
163 
167 
171  type1 accessor1() const
172  {
173  return M_data1;
174  }
175 
180  type2 acessor2() const
181  {
182  return M_data2;
183  }
184 
186 
190 
194  type1 setData1( int dim )
195  {
196  M_data1 = dim;
197  }
198 
200 
201 
205 
215  type1 methode1( ptype1 parameter1, ptype2 parameter2);
216 
218 
219 private:
220 
221  // Private data wont be documented
222 
223 protected:
226 
227 };
228 
229 }
230 
231 
233 
234 // All the code between '\cond DETAIL' and '\endcond' wont be documented.
235 // Use this command to hide obsolete or useless parts.
236 
238 
239 // The following boost function wont be documented
240 BOOST_PARAMETER_FUNCTION(
241  ( typename exampletype ), // return type
242  examplefun, // 2. function name
243 
244  tag, // 3. namespace of tag types
245 
246  ( required
247  ( param, * )
248  )
249  ( optional
250  )
251 { }
252  )
type1 setData1(int dim)
set the data1
Definition: example.hpp:194
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:180
type1 accessor1() const
Definition: example.hpp:171
Brief description of the class Example.
Definition: example.hpp:137
object1
this is a short description of object1
Definition: example.hpp:225