/[ascend]/trunk/tcltk98/generic/interface/SolverGlobals.h
ViewVC logotype

Annotation of /trunk/tcltk98/generic/interface/SolverGlobals.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 54 - (hide annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (16 years, 10 months ago) by jds
File MIME type: text/x-chdr
File size: 2149 byte(s)
Manual rework of doxygen comments in all headers.
- Added @file comment to all headers.
- Added parameter names to all function declarations in headers.
- Corrected comment referencing where necessary.
- Split some comments which documented blocks of declarations.
- Converted notes about required work into @todo comments so doxygen can generate a todo list.
Minor bug fixes.
1 aw0a 1 /*
2     * SolverGlobals.h
3     * by Ben Allan
4     * Created: 7/97
5     * Version: $Revision: 1.2 $
6     * Version control file: $RCSfile: SolverGlobals.h,v $
7     * Date last modified: $Date: 1997/07/18 12:23:49 $
8     * Last modified by: $Author: mthomas $
9     *
10     * This file is part of the ASCEND Tcl/Tk interface
11     *
12     * Copyright 1997, Carnegie Mellon University
13     *
14     * The ASCEND Tcl/Tk interface is free software; you can redistribute
15     * it and/or modify it under the terms of the GNU General Public License as
16     * published by the Free Software Foundation; either version 2 of the
17     * License, or (at your option) any later version.
18     *
19     * The ASCEND Tcl/Tk interface is distributed in hope that it will be
20     * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22     * General Public License for more details.
23     *
24     * You should have received a copy of the GNU General Public License
25     * along with the program; if not, write to the Free Software Foundation,
26     * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27     * COPYING. COPYING is found in ../compiler.
28     */
29    
30 jds 54 /** @file
31     * Global variables used to maintain a single global solver system.
32     * This is bad.
33     * The storage of these variables is in SolverProc.c.
34     * <pre>
35     * Requires: #include "utilities/ascConfig.h"
36     * #include "solver/slv_client.h"
37     * #include "compiler/instance_enum.h"
38     * </pre>
39     * @todo If this is really bad, rework it.
40     * @todo Complete documentation of interface/SolverGlobals.h.
41     */
42    
43 aw0a 1 #ifndef SolverGlobals_module_loaded
44     #define SolverGlobals_module_loaded
45    
46     /*
47     * The following global variables are used to maintain
48     * a single global solver system.
49     * This is bad.
50     * The storage of these variables is in SolverProc.c.
51     */
52 jds 54 extern int g_solvinst_ndx;
53     extern int g_solvinst_limit;
54     extern slv_system_t g_browsys_cur;
55     extern slv_system_t g_solvsys_cur;
56     extern struct Instance *g_solvinst_root; /**< solver root instance */
57     extern struct Instance *g_solvinst_cur; /**< solver current instance */
58 aw0a 1
59 jds 54 #endif /* SolverGlobals_module_loaded */
60    

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22