share/autogen/aginfo3.tpl

   1 {+ AutoGen5 template  -*- nroff -*-
   2
   3 ## ---------------------------------------------------------------------
   4 ## aginfo3.tpl -- Template for function texi doc
   5 ##
   6 ##  AutoOpts copyright 1992-2002 Bruce Korb
   7 ##
   8 ## Time-stamp:      "2002-05-07 21:01:49 bkorb"
   9 ## Author:          Bruce Korb <bkorb@gnu.org>
  10 ## Maintainer:      Bruce Korb <bkorb@gnu.org>
  11 ## Created:         Mon Jun 28 15:35:12 1999
  12 ##              by: bkorb
  13 ## ---------------------------------------------------------------------
  14 ## $Id: aginfo3.tpl,v 2.3 2002/05/11 21:19:58 bkorb Exp $
  15 ## ---------------------------------------------------------------------
  16
  17 texi
  18
  19 (setenv "SHELL" "/bin/sh")
  20
  21 +}{+
  22
  23 (out-push-new (sprintf "%s.menu" (base-name)))
  24 (define node-name (sprintf "lib%s procedures" (get "library")))
  25 (define sec-name  (sprintf "lib%s External Procedures" (get "library")))
  26
  27 (define doc-level (getenv "LEVEL"))
  28 (if (not (string? doc-level))
  29     (set! doc-level "section"))
  30 (sprintf "* %-28s %s\n" (string-append node-name "::") sec-name)  +}{+
  31 (out-pop)
  32 +}@node {+ (. node-name) +}
  33 @{+ (. doc-level) +} {+ (. sec-name) +}
  34
  35 {+
  36
  37 IF (not (exist? "lib-description"))
  38
  39 +}These are the publicly exported procedures from the lib@i{library}
  40 library.  Any other functions mentioned in the @i{header} file are
  41 for the private use of the library.{+
  42
  43 ELSE  +}{+  lib-description +}{+
  44 ENDIF +}
  45
  46 @menu{+
  47
  48 FOR export_func               +}{+
  49   IF (not (exist? "private")) +}
  50 * lib{+(sprintf "%-24s" (string-append
  51        (get "library") "-" (get "name") "::"))
  52     +} {+name      +}{+
  53
  54   ENDIF private    +}{+
  55
  56 ENDFOR export_func +}
  57 @end menu
  58
  59 This {+(. doc-level)+} was automatically generated by AutoGen
  60 using extracted information and the {+(tpl-file)+} template.{+
  61
  62 FOR export_func                +}{+
  63   IF (not (exist? "private"))
  64
  65 +}
  66
  67 @node lib{+library+}-{+name+}
  68 @{+CASE (. doc-level)+}{+
  69    = chapter    +}{+
  70    = section    +}sub{+
  71    = subsection +}subsub{+
  72    ESAC +}section {+name+}
  73 @findex {+name+}
  74
  75 {+what+}
  76
  77 @noindent
  78 Usage:
  79 @example
  80 {+ % ret-type "%s res = "
  81 +}{+name+}({+
  82   IF (exist? "arg") +} {+
  83     FOR arg ", " +}{+arg-name+}{+
  84     ENDFOR +} {+
  85   ENDIF +});
  86 @end example{+
  87   IF (or (exist? "arg") (exist? "ret-type")) +}
  88 @noindent
  89 Where the arguments are:
  90 @multitable @columnfractions .05 .15 .20 .55
  91 @item @tab Name @tab Type @tab Description
  92 @item @tab ----- @tab ----- @tab -------------{+
  93     FOR arg "\n" +}
  94 @item @tab {+arg-name+} @tab @code{{+arg-type+}}
  95 @tab {+arg-desc+}{+
  96     ENDFOR+}{+
  97     IF (exist? "ret-type") +}
  98 @item @tab returns @tab {+ret-type+}
  99 @tab {+ ret-desc +}{+
 100
 101     ENDIF +}
 102 @end multitable{+
 103
 104   ENDIF
 105 +}
 106
 107 {+doc+}
 108 {+ % err "\n%s\n" +}{+
 109
 110   ENDIF private  +}{+
 111
 112 ENDFOR  export_func
 113
 114
 115 +}