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

Contents of /trunk/tcltk98/generic/interface/AscPrintTcl.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 54 - (show annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (16 years, 9 months ago) by jds
File MIME type: text/x-chdr
File size: 2208 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 * Tcl Printf Substitutes
3 * by Mark Thomas
4 * Created: 27.May.1997
5 * Version: $Revision: 1.6 $
6 * Version control file: $RCSfile: ascPrint.h,v $
7 * Date last modified: $Date: 1997/10/29 13:08:50 $
8 * Last modified by: $Author: mthomas $
9 *
10 * This file is part of the ASCEND utilities.
11 *
12 * Copyright 1997, Carnegie Mellon University
13 *
14 * The ASCEND utilities 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 utilities 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 /** @file
31 * Tcl Printf Substitutes
32 * <pre>
33 * When including this file, you must include:
34 * #include <stdarg.h>
35 * #include "utilities/ascConfig.h"
36 * #include "compiler/compiler.h"
37 * #include "utilities/ascPrint.h"
38 * </pre>
39 */
40
41 #ifndef _ASCPRINTTCL_H
42 #define _ASCPRINTTCL_H
43
44 extern int Asc_PrintInit_TclVtable(void);
45 /**<
46 * Set up the vtable on the print stack.
47 * This can be done before Asc_PrintInit_Tcl(), and
48 * the result will be stderr/stdout output.
49 * Always returns 0.
50 */
51
52 extern int Asc_PrintInit_Tcl(void);
53 /**<
54 * Initialize tcltk98 interface pointers to the Tcl channels used for output.
55 *
56 * This function should be called after the Tcl channels have been
57 * initialized. Any calls to Asc_Printf() made prior to calling
58 * Asc_PrintInit() will use ordinary printf(). Returns 0 if the
59 * initialization is successful, non-zero if any of the Tcl
60 * channels could not be initialized.
61 */
62
63 extern void Asc_PrintFinalize_Tcl(void);
64 /**< Shut down the print channels of Tcl. */
65
66 #endif /* _ASCPRINTTCL_H */
67

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