/[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 33 - (hide annotations) (download) (as text)
Sun Dec 26 20:06:01 2004 UTC (19 years, 9 months ago) by ben.allan
File MIME type: text/x-chdr
File size: 1790 byte(s)
First pass at doxygenation -- mechanically putting in ** and where
most likely needed **< using sed. Lots of cleanup needed to
be really useful, including grouping data types and their
member methods into class-like documentation.
1 ben.allan 33 /**<
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     #ifndef __REL_COMMON_H_SEEN__
28     #define __REL_COMMON_H_SEEN__
29    
30    
31     extern int CmpP(CONST char *, CONST char *);
32 ben.allan 33 /**<
33 aw0a 1 * int CmpP(c1,c2)
34     * CONST char *c1;
35     * CONST char *c2;
36     * Compare two character pointers.
37     */
38    
39     extern void Swap(unsigned long int *, unsigned long int *);
40 ben.allan 33 /**<
41 aw0a 1 * void Swap(p1,p2)
42     * unsigned long int *p1
43     * unsigned long int *p2
44     * unsigned long temp
45     * Exchange the value of pointers p1 and p2
46     */
47    
48     extern CONST struct Expr *FindLastExpr(register CONST struct Expr *);
49 ben.allan 33 /**<
50 aw0a 1 * CONST struct Expr *FindLastExpr(ex)
51     * register CONST struct Expr *ex
52     * Return the next pointer in a link of expressions
53     */
54    
55    
56     #endif /*__ REL_COMMON_H_SEEN__ */

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