/[ascend]/trunk/base/generic/compiler/destroyinst.h
ViewVC logotype

Contents of /trunk/base/generic/compiler/destroyinst.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1066 - (show annotations) (download) (as text)
Sun Jan 7 10:02:41 2007 UTC (17 years, 9 months ago) by johnpye
File MIME type: text/x-chdr
File size: 2175 byte(s)
Adding doxygen 'addtogroup' for Solver, Compiler, Integrator.
1 /*
2 * Ascend Instance Tree Killing
3 * by Tom Epperly
4 * 8/16/89
5 * Version: $Revision: 1.6 $
6 * Version control file: $RCSfile: destroyinst.h,v $
7 * Date last modified: $Date: 1997/07/18 12:28:54 $
8 * Last modified by: $Author: mthomas $
9 *
10 * This file is part of the Ascend Language Interpreter.
11 *
12 * Copyright (C) 1996 Ben Allan
13 * based on instance.c
14 * Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
15 *
16 * The Ascend Language Interpreter is free software; you can redistribute
17 * it and/or modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of the
19 * License, or (at your option) any later version.
20 *
21 * The Ascend Language Interpreter is distributed in hope that it will be
22 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with the program; if not, write to the Free Software Foundation,
28 * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
29 * COPYING.
30 */
31
32 /** @file
33 * Ascend Instance Tree Killing.
34 * <pre>
35 * When #including destroyinst.h, make sure these files are #included first:
36 * #include "utilities/ascConfig.h"
37 * #include "instance_enum.h"
38 * </pre>
39 */
40
41 #ifndef ASC_DESTROYINST_H
42 #define ASC_DESTROYINST_H
43
44 /** addtogroup compiler Compiler
45 @{
46 */
47
48 ASC_DLLSPEC void DestroyInstance(struct Instance *inst, struct Instance *parent);
49 /**<
50 * If parent is NULL, this will destroy all references to inst and deallocate
51 * the memory associated with inst. It will delete inst's reference to its
52 * children. If parent is not NULL, this will destroy parent's reference
53 * to inst. If this is the only reference to inst, it will deallocate the
54 * memory associated with inst.<br><br>
55 *
56 * DestroyInstance will modify the parent's of inst to remove the reference.
57 */
58 /*
59 * void DestroyInstance(inst,parent)
60 * struct Instance *inst,*parent;
61 */
62
63 /* @} */
64
65 #endif /* ASC_DESTROYINST_H */
66

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