texinfo/info/doc.h

   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 #include "info.h" /* for NAMED_FUNCTIONS, VFunction, etc.  */
  28
  29 typedef struct {
  30   VFunction *func;
  31 #if defined (NAMED_FUNCTIONS)
  32   char *func_name;
  33 #endif /* NAMED_FUNCTIONS */
  34   char *doc;
  35 } FUNCTION_DOC;
  36
  37 extern FUNCTION_DOC function_doc_array[];
  38
  39 extern char *function_documentation ();
  40 extern char *key_documentation ();
  41 extern char *pretty_keyname ();
  42 extern char *replace_in_documentation ();
  43 extern void info_document_key ();
  44 extern void dump_map_to_message_buffer ();
  45
  46 #if defined (NAMED_FUNCTIONS)
  47 extern char *function_name ();
  48 extern VFunction *named_function ();
  49 #endif /* NAMED_FUNCTIONS */
  50 #endif /* !DOC_H */