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

Annotation of /trunk/base/generic/compiler/rel_common.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 54 - (hide annotations) (download) (as text)
Tue Aug 2 11:20:09 2005 UTC (19 years, 2 months ago) by jds
File MIME type: text/x-chdr
File size: 2471 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 jds 54 /*
2 aw0a 1 * Common Relation Construction Routines
3     * Version: $Revision: 1.4 $
4     * Version control file: $RCSfile: rel_common.h,v $
5     * Date last modified: $Date: 1997/07/18 12:33:09 $
6     * Last modified by: $Author: mthomas $
7     *
8     * This file is part of the Ascend Language Interpreter.
9     *
10     * Copyright (C) 1997 Carnegie Mellon University
11     *
12     * The Ascend Language Interpreter is free software; you can redistribute
13     * it and/or modify it under the terms of the GNU General Public License as
14     * published by the Free Software Foundation; either version 2 of the
15     * License, or (at your option) any later version.
16     *
17     * The Ascend Language Interpreter is distributed in hope that it will be
18     * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
19     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20     * General Public License for more details.
21     *
22     * You should have received a copy of the GNU General Public License along
23     * with the program; if not, write to the Free Software Foundation, Inc., 675
24     * Mass Ave, Cambridge, MA 02139 USA. Check the file named COPYING.
25     */
26    
27 jds 54 /** @file
28     * Common Relation Construction Routines.
29     * <pre>
30     * When #including rel_common.h, make sure these files are #included first:
31     * #include "utilities/ascConfig.h"
32     * #include "types.h"
33     * </pre>
34     */
35    
36 aw0a 1 #ifndef __REL_COMMON_H_SEEN__
37     #define __REL_COMMON_H_SEEN__
38    
39 jds 54 extern int CmpP(CONST char *c1, CONST char *c2);
40 ben.allan 33 /**<
41 jds 54 * <!-- int CmpP(c1,c2) -->
42     * <!-- CONST char *c1; -->
43     * <!-- CONST char *c2; -->
44 aw0a 1 * Compare two character pointers.
45     */
46    
47 jds 54 extern void Swap(unsigned long int *p1, unsigned long int *p2);
48 ben.allan 33 /**<
49 jds 54 * <!-- void Swap(p1,p2) -->
50     * <!-- unsigned long int *p1 -->
51     * <!-- unsigned long int *p2 -->
52     * <!-- unsigned long temp -->
53 aw0a 1 * Exchange the value of pointers p1 and p2
54     */
55    
56 jds 54 extern CONST struct Expr *FindLastExpr(register CONST struct Expr *ex);
57 ben.allan 33 /**<
58 jds 54 * <!-- CONST struct Expr *FindLastExpr(ex) -->
59     * <!-- register CONST struct Expr *ex -->
60 aw0a 1 * Return the next pointer in a link of expressions
61     */
62    
63 jds 54 #endif /*__ REL_COMMON_H_SEEN__ */
64 aw0a 1

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