2502
|
1 /* doc.h -- Structure associating function pointers with documentation. */ |
|
2 |
|
3 /* This file is part of GNU Info, a program for reading online documentation |
|
4 stored in Info format. |
|
5 |
|
6 Copyright (C) 1993 Free Software Foundation, Inc. |
|
7 |
|
8 This program is free software; you can redistribute it and/or modify |
|
9 it under the terms of the GNU General Public License as published by |
|
10 the Free Software Foundation; either version 2, or (at your option) |
|
11 any later version. |
|
12 |
|
13 This program is distributed in the hope that it will be useful, |
|
14 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
16 GNU General Public License for more details. |
|
17 |
|
18 You should have received a copy of the GNU General Public License |
|
19 along with this program; if not, write to the Free Software |
|
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
21 |
|
22 Written by Brian Fox (bfox@ai.mit.edu). */ |
|
23 |
|
24 #if !defined (_DOC_H_) |
|
25 #define _DOC_H_ |
|
26 |
|
27 #if !defined (NULL) |
|
28 # define NULL 0x0 |
|
29 #endif /* !NULL */ |
|
30 |
|
31 #if !defined (__FUNCTION_DEF) |
|
32 # define __FUNCTION_DEF |
|
33 typedef int Function (); |
|
34 typedef void VFunction (); |
|
35 #endif /* _FUNCTION_DEF */ |
|
36 |
|
37 typedef struct { |
|
38 VFunction *func; |
|
39 #if defined (NAMED_FUNCTIONS) |
|
40 char *func_name; |
|
41 #endif /* NAMED_FUNCTIONS */ |
|
42 char *doc; |
|
43 } FUNCTION_DOC; |
|
44 |
|
45 extern FUNCTION_DOC function_doc_array[]; |
|
46 |
|
47 extern char *function_documentation (); |
|
48 extern char *key_documentation (); |
|
49 extern char *pretty_keyname (); |
|
50 extern char *replace_in_documentation (); |
|
51 extern void info_document_key (); |
|
52 extern void dump_map_to_message_buffer (); |
|
53 |
|
54 #if defined (NAMED_FUNCTIONS) |
|
55 extern char *function_name (); |
|
56 extern VFunction *named_function (); |
|
57 #endif /* NAMED_FUNCTIONS */ |
|
58 #endif /* !_DOC_H_ */ |