annotate info/doc.h @ 2875:2e45e7a3d45e

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