GNU Info

(idlwave)Routine Information Sources

---

Next: Library Catalog Prev: Routine Definitions Up: Sources of Routine Info

---

Enter node , (file) or (file)node

Routine Information Sources
===========================

   In oder to know about as many routines as possible, IDLWAVE will do
the following to collect information:

  1. It has a _builtin list_ with the properties of the builtin IDL
     routines.  IDLWAVE 4.7 is distributed with a list of 1287 routines
     and 5724 keywords, reflecting IDL version 5.4.  This list has been
     created by scanning the IDL manuals and is stored in the file
     `idlw-rinfo.el'.  Note: Documentation Scan, for information how
     to regenerate this file for new versions of IDL.

  2. It _scans_ all _buffers_ of the current Emacs session for routine
     definitions.  This is done automatically when routine information
     or completion is first requested by the user.  Each new buffer and
     each buffer which is saved after making changes is also scanned.
     The command `C-c C-i' (`idlwave-update-routine-info') can be used
     at any time to rescan all buffers.

  3. If you have an IDLWAVE-Shell running as inferior process of the
     current Emacs session, IDLWAVE will _query the shell_ for compiled
     routines and their arguments.  This happens automatically when
     routine information or completion is first requested by the user,
     and each time an Emacs buffer is compiled with `C-c C-d C-c'.  The
     command `C-c C-i' (`idlwave-update-routine-info') can be used to
     ask the shell again at any time.

  4. IDLWAVE can scan all or selected library files and store the
     result in a file which will be automatically loaded just like
     `idlw-rinfo.el'. Note: Library Catalog, for information how to
     scan library files.

 - User Option: idlwave-scan-all-buffers-for-routine-info (`t')
     Non-`nil' means, scan all buffers for IDL programs when updating
     info.

 - User Option: idlwave-query-shell-for-routine-info (`t')
     Non-`nil' means query the shell for info about compiled routines.

 - User Option: idlwave-auto-routine-info-updates
     Controls under what circumstances routine info is updated
     automatically.