13.25 guile-tools make-twerp2texi-index

See Doc Indexing, for discussion.

Usage: make-twerp2texi-index [-o DOT-DOC-INDEX] [DOT-DOC ...]

Scan the DOT-DOC files and write DOT-DOC-INDEX, an index file for use
by (later) twerp2texi invocation, q.v.  DOT-DOC-INDEX should be in the
current directory, and each DOT-DOC file should be under the current
directory (subdirectories ok).  Typically, you would add to Makefile.am
something like:

  DOT_DOC_FILES = foo.doc bar.doc sub/foo.doc sub/bar.doc ...
  .doc-index: $(DOT_DOC_FILES)
         guile-tools make-twerp2texi-index -o $@ $(DOT_DOC_FILES)

This writes .doc-index whenever any of the .doc files change.  See
guile-tool "doc-snarf" for creating .doc files.


Usage from a Scheme program:
  (make-twerp2texi-index files) => index

Return a nested list representing the index of FILES.
FILES is a list of filenames, typically of the type produced by
"guile-tools doc-snarf" (.doc) or "guile-tools c2doc" (.cdoc).

The return value is an assoc list, the keys of which are the FILES,
and the associated value a list of zero or more elements describing
functions found in each file, having the form:

  (NAME "ARGLIST" START END)

NAME is a symbol; ARGLIST is a string that may contain spaces, square
brackets and other strange characters; and both START and END are
byte positions (integers) in FILE between which NAME's docstring can
be found.