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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 54 - (show annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (15 years, 1 month ago) by jds
File MIME type: text/x-chdr
File size: 2440 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 /*
2 * When Output Routines
3 * by Vicente Rico-Ramirez
4 * Version: $Revision: 1.7 $
5 * Version control file: $RCSfile: when_io.h,v $
6 * Date last modified: $Date: 1997/07/29 15:52:58 $
7 * Last modified by: $Author: rv2a $
8 *
9 * This file is part of the Ascend Language Interpreter.
10 *
11 * Copyright (C) 1997 Carnegie Mellon University
12 *
13 * The Ascend Language Interpreter is free software; you can redistribute
14 * it and/or modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) any later version.
17 *
18 * The Ascend Language Interpreter is distributed in hope that it will be
19 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with the program; if not, write to the Free Software Foundation,
25 * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
26 * COPYING.
27 *
28 */
29
30 /** @file
31 * When Output Routines.
32 * <pre>
33 * When #including when_io.h, make sure these files are #included first:
34 * #include <stdio.h>
35 * #include "utilities/ascConfig.h"
36 * #include "instance_enum.h"
37 * </pre>
38 */
39
40 #ifndef __WHENINST_IO_H_SEEN__
41 #define __WHENINST_IO_H_SEEN__
42
43 /*===========================*/
44
45 extern void WriteWhen(FILE *f, CONST struct Instance *wheninst,
46 CONST struct Instance *ref);
47 /**<
48 * <!-- void WriteWhen(f,wheninst,ref); -->
49 * <!-- FILE *f; -->
50 * <!-- CONST struct Instance *wheninst; -->
51 * <!-- CONST struct Instance *ref; -->
52 * Write a when instance to the file f
53 */
54
55 extern char *WriteWhenString(CONST struct Instance *wheninst,
56 CONST struct Instance *ref);
57 /**<
58 * <!-- char WriteWhenString(wheninst,ref); -->
59 * <!-- char *result; -->
60 * <!-- CONST struct Instance *wheninst; -->
61 * <!-- CONST struct Instance *ref; -->
62 * Write a when instance to a char
63 */
64
65 #endif /* __WHENINST_IO_H_SEEN__ */
66

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