MADNESS  version 0.9
example_doc.h
Go to the documentation of this file.
1 /*
2  This file is part of MADNESS.
3 
4  Copyright (C) 2007,2010 Oak Ridge National Laboratory
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with this program; if not, write to the Free Software
18  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 
20  For more information please contact:
21 
22  Robert J. Harrison
23  Oak Ridge National Laboratory
24  One Bethel Valley Road
25  P.O. Box 2008, MS-6367
26 
27  email: harrisonrj@ornl.gov
28  tel: 865-241-3937
29  fax: 865-572-0680
30 
31  $Id$
32 */
33 
62 // @{
63 
65 
69 public:
70  int datum;
71 
73 
81  int reality(int hope, int despair) const;
82 };
83 
90 public:
92 
98  int morose(int fud, int& bs) {};
99 
100  void fred(double mary); /* Fred is documented in example_doc.cc */
101 };
102 
103 
105 // @{
106 int stuff;
107 
108 /* Closing subgroup membership */
109 // @}
110 
112 
115 int example_func(int a);
116 
117 /* Closing group membership */
118 // @}
119 
120 
121 
122 
123 
int morose(int fud, int &bs)
Brief documentation on member function.
Definition: example_doc.h:98
Every class should be documented (this is the brief line)
Definition: example_doc.h:68
int datum
Each member datum needs at least a brief raison d'etre.
Definition: example_doc.h:70
Brief documentation of second example class in group.
Definition: example_doc.h:89
FLOAT a(int j, FLOAT z)
Definition: y1.cc:86
void fred(double mary)
Brief documentation on class member coming from example_doc.cc.
int example_func(int a)
Global function in example group.
int reality(int hope, int despair) const
Each member function should be documented (this is the brief line)
int stuff
Global variable somewhere in example subgroup.
Definition: example_doc.h:106