xemacs-beta: man/oo-browser.texi comparison

comparison man/oo-browser.texi @ 24:4103f0995bd7 r19-15b95

Import from CVS: tag r19-15b95

author	cvs
date	Mon, 13 Aug 2007 08:51:03 +0200
parents	49a24b4fd526
children	131b0175ea99

comparison

equal deleted inserted replaced

-:0edd3412f124
+:4103f0995bd7
 \input psfig.sty
 \input texinfo  @c -*-texinfo-*-
 @c
 @c SUMMARY:      The OO-Browser User Manual for V2
-@c USAGE:        Hardcopy man from TeX; Info man from 'texinfo-format-buffer'.
+@c USAGE:        Hardcopy man from TeX; Info man from `texinfo-format-buffer'.
 @c
 @c AUTHOR:       Bob Weiner
-@c ORG:          Motorola Inc., PPG
+@c
+@c ORG:          InfoDock Associates.  We sell corporate support and
+@c               development contracts for InfoDock, Emacs and XEmacs.
+@c               E-mail: <info@infodock.com>  Web: http://www.infodock.com
+@c               Tel: +1 408-243-3300
+@c
 @c ORIG-DATE:    10-Apr-90
-@c LAST-MOD:      2-May-96 at 23:36:02 by Harri Pasanen
+@c LAST-MOD:     21-Feb-97 at 18:36:33 by Bob Weiner
 @c
 @c DESCRIPTION:
 @c DESCRIP-END.
 @c %**start of header (This is for running Texinfo on a region.)
 @center @titlefont{The OO-Browser User Manual}
 @sp 1
 @center The Multi-language Object-Oriented Code Browser
 @sp 5
 @center Bob Weiner
-@center Motorola Inc.
+@center InfoDock Associates
-@center E-mail: <oo-browser@@hub.ucsb.edu>  (This is a mailing list.)
+@sp 1
+@center E-mail: <oo-browser@@infodock.com>  (This is a mailing list.)
 @sp 2
-@center Edition 2.9.12
+@center Edition 2.10
 @sp 2
-@center May 1996
+@center February 19, 1997
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1989-1995  Free Software Foundation, Inc.
+Copyright @copyright{} 1989-1997  Free Software Foundation, Inc.
 All trademarks referenced herein are trademarks of their respective
 holders.
+InfoDock Associates, the developer of the OO-Browser and InfoDock (an
+industrial quality turn-key version of XEmacs), donates its work on
+the OO-Browser to the Free Software Foundation and makes it freely
+available for worldwide distribution.
+InfoDock Associates is a commercial firm dedicated to radical productivity
+improvement in technical environments, whether in software development or
+other knowledge intensive disciplines.  Our initial offerings include high
+quality commercial support, training, books and custom package development
+for InfoDock, XEmacs or GNU Emacs on a variety of platforms.
+@example
+E-mail: <info@@infodock.com>
+Web:    http://www.infodock.com
+Tel:    +1 408-243-3300
+@end example
 @setchapternewpage on
 @end titlepage
 @page
 @node Top, Introduction, (dir), (dir)
 @c  node-name,  next,  previous,  up
 @unnumbered Preface
 @ifinfo
 @noindent
-Copyright @copyright{} 1989-1996  Free Software Foundation, Inc.
+Copyright @copyright{} 1989-1997  Free Software Foundation, Inc.
 All trademarks referenced herein are trademarks of their respective holders.
+InfoDock Associates, the developer of the OO-Browser and InfoDock (an
+industrial quality turn-key version of XEmacs), donates its work on
+the OO-Browser to the Free Software Foundation and makes it freely
+available for worldwide distribution.
+InfoDock Associates is a commercial firm dedicated to radical productivity
+improvement in technical environments, whether in software development or
+other knowledge intensive disciplines.  Our initial offerings include high
+quality commercial support, training, books and custom package development
+for InfoDock, XEmacs or GNU Emacs on a variety of platforms.
+@example
+E-mail: <info@@infodock.com>
+Web:    http://www.infodock.com
+Tel:    +1 408-243-3300
+@end example
 @end ifinfo
 This edition of the OO-Browser User Manual is for use with any version
-2.9.12 or greater of the OO-Browser.  The OO-Browser is available for
+2.10 or greater of the OO-Browser.  The OO-Browser is available for
 free use, distribution, and modification under the terms of version 2 or
 later of the GNU Public License (GPL).  No representations are made
 about the suitability of this software for any purpose.  It is provided
 "as is" without express or implied warranty.
 @cindex credits
 @cindex InfoDock, obtaining
 @cindex OO-Browser, obtaining
 @cindex anonymous ftp
-The OO-Browser was designed and written by Bob Weiner.  Motorola,
+The OO-Browser was designed and written by Bob Weiner of InfoDock
-Inc. funded and donated this work for free redistribution as part of the
+Associates.  Motorola, Inc@. help fund early work.  Torgeir Veimo and
-InfoDock integrated productivity toolset.  Torgeir Veimo and Mark Stern
+Mark Stern helped write the X OO-Browser core.  Don Yacktman helped
-helped write the X OO-Browser core.  Don Yacktman helped write the
+write the NEXTSTEP OO-Browser core.  Jeff Sparkes helped with the Java
-NEXTSTEP OO-Browser core.  Jeff Sparkes helped with the Java language
+language support.  Harri Pasanen helped with the Python language
-support.  Harri Pasanen implemented the Python language support, and
+support.
-updated the documentation to reflect that addition.
 @vindex file, BR-README
 @cindex README file
 @cindex installation
 The OO-Browser and InfoDock can be obtained via anonymous ftp on the
-Internet from: @file{/anonymous@@ftp.xemacs.org:/pub/infodock}.
+Internet from: @file{ftp://ftp.xemacs.org/pub/infodock}.
 Installation instructions for the OO-Browser can be found in the
 @file{BR-README} file in the OO-Browser distribution.
 This manual documents the user interface and operation of the OO-Browser
 multi-language browser.  It assumes a very basic familiarity in the use
 * Graphical Browsing::          Graphical OO-Browser Interfaces
 OO-Browser Options
 * External Viewing::            Using An External Viewer or Editor
+* Inherited Features::          Toggling Inherited Feature Display
+* Graphical Add Features::      Add Features to a Graphical View
 * Keep Viewed Classes::
 * Inhibit Version::             Inhibit Version Screen
 * Invert Ancestors::            Invert Ancestor Trees
 * Save All::                    Save All Lookup Tables
 * Use Children::                Build Children Lookup Table
 @c  node-name,  next,  previous,  up
 @unnumbered Introduction
 @cindex OO-Browser
 @cindex Smalltalk
-The @dfn{OO-Browser} is a multi-windowed, interactive, object-oriented
+The @dfn{OO-Browser} (pronounced owe-owe-browse-er) is a multi-windowed,
-class browser designed for professional use.  Its user interface is
+interactive, object-oriented class browser designed for professional
-similar to the well-known Smalltalk browsers @cite{[Goldberg 83]}, yet
+use.  Its user interface is similar to the well-known Smalltalk browsers
-it is much more flexible and easy to use.
+@cite{[Goldberg 83]}, yet it is much more flexible and easy to use.
 @cindex Eiffel
 @cindex C++
 @cindex C
 @cindex Objective-C
 @cindex Info
 @noindent
 The OO-Browser is unique in several respects:
 @itemize @bullet
 @item
-It currently supports seven object-oriented languages (Eiffel, C++,
+It currently supports seven object-oriented languages (C++, CLOS (Lisp),
-Objective-C, CLOS (Lisp), Java, Python and Smalltalk), one non-object-oriented
+Eiffel, Java, Objective-C, Python and Smalltalk), one
-language (C), and one documentation language, (GNU Info).
+non-object-oriented language (C), and one documentation language, (GNU
+Info).
 @item
 It may be used for both system exploration and for browsing purposes as
 part of a professional software development tool chest.
 @sp 2
 @centerline{@psfig{figure=im/oobr-text.eps}}
 @end iftex
 @ifinfo
 Mouse click on the following filename to view a picture of
-the textual OO-Browser: "im/oobr-text.eps".  Under InfoDock, use the
+the textual OO-Browser: @file{im/oobr-text.eps}.  Under InfoDock, use the
 middle mouse button.  Under Emacs with the Hyperbole system loaded, use
 the shift-middle mouse button or shift-left on a two button mouse.
 Otherwise, there is no built-in way to view the picture.
 @end ifinfo
 Alternatively, you can invoke the browser on a specific language
 Environment, e.g@. to bring back the last Environment browsed under that
 language.  The language-specific browser invocation commands are:
 @{@kbd{M-x eif-browse @key{RET}}@}, @{@kbd{M-x c++-browse @key{RET}}@},
 @{@kbd{M-x info-browse @key{RET}}@}, @{@kbd{M-x clos-browse
-@key{RET}}@}, @{@kbd{M-x objc-browse @key{RET}}@}, @{@kbd{M-x python-browse @key{RET}}@}.@refill
+@key{RET}}@}, @{@kbd{M-x objc-browse @key{RET}}@},
+@{@kbd{M-x python-browse @key{RET}}@}.@refill
 @cindex Environment file
 @cindex prefix argument
 @cindex Environment, prompting for
 @noindent
 When the command is invoked (first time through the loop), if the
 @{@key{RET}@} key is pressed without giving a match expression, the search
 will match to all classes referenced in the Environment.
 If you want a regular expression to match to whole class names
-exclusively, begin it with a '^' and end it with a '$' character which
+exclusively, begin it with a `^' and end it with a `$' character which
 match to beginning of name and end of name, respectively.  Thus, "^....$"
 would match to class names with exactly four characters.  A string
 match always matches to any class name that contains the matching
 string.
 When the command is invoked (first time through the loop), if the
 @{@key{RET}@} key is pressed without giving a match expression, the search
 will match to all entries in the listing, so no filtering will be done.
 If you want a regular expression to match to whole entries
-exclusively, begin it with a '^' and end it with a '$' character which
+exclusively, begin it with a `^' and end it with a `$' character which
 match to beginning of line and end of line, respectively.  Thus, "^....$"
 would match to entry lines with exactly four characters.  A string
 match always matches to any entry that contains the matching string.
 default behavior.
 @cindex Eiffel, short
 @cindex Eiffel, flat
 @{@kbd{M-x eif-info-use-short}@} will instead cause the
-@code{(br-entry-info)} command to run the Eiffel 'short' command on a
+@code{(br-entry-info)} command to run the Eiffel `short' command on a
 class, thereby displaying its specification.
 @{@kbd{M-x eif-info-use-flat}@}, will cause the command to run
-the Eiffel 'flat' command on a class, thereby displaying its complete
+the Eiffel `flat' command on a class, thereby displaying its complete
 feature set.  Use @{@kbd{M-x eif-info-use-calls}@} to reset this command
 to its default behavior.
 @node Adding and Deleting Classes, Completing Names, Class Info, Usage
 @cindex NEXTSTEP OO-Browser
 @cindex graphical browsing
 The X interface to the OO-Browser is called, @dfn{xoobr}.  It provides a
 simple but effective means of navigating through OO-Browser hierarchy
 and element relations.  (The NEXTSTEP OO-Browser is very similar to the
-X version, so use the documentation herein if you need any help with it.)
+X version, so the documentation herein also applies to it.)
 Any number of xoobr sessions may be established at the same time.  Each
 one is used to gain a particular view on an Environment.  The textual
 OO-Browser is used to filter a set of classes for display in an xoobr
 process.  For this reason, xoobr is invoked from within the textual
 @sp 2
 @centerline{@psfig{figure=im/oobr-x.ps}}
 @end iftex
 @ifinfo
 If running under the X window system, Action Key click on the following
-filename to view a picture of the X OO-Browser: "im/oobr-x.xwd".
+filename to view a picture of the X OO-Browser: @file{im/oobr-x.xwd}.
 @end ifinfo
+@kindex M-f
+@findex br-tree-features-toggle
+@cindex xoobr, displaying features
+@cindex descendancy view
+@{@kbd{M-f}@} @code{(br-tree-features-toggle)} or the menu item,
+@emph{Options/Graphical-Add-Features}, is used before creating a
+graphical descendency view to determine whether or not to include the
+features of each class in the listing as child nodes of the class.
+It toggles between showing features and not showing them in descendancy
+views.  The setting applies across all OO-Browser languages.  The
+default setting is not to add features to the view.
 @kindex M-g
 @findex br-tree-graph
 @cindex xoobr, graphical view
 @{@kbd{M-g}@} @code{(br-tree-graph)} displays the current listing
 @kindex M-d
 @findex br-tree
 @cindex xoobr, descendants
 @{@kbd{M-d}@} @code{(br-tree)} selects the current class and displays
 its descendancy graph in tree-form by starting a new xoobr session.
-With a prefix argument, @{@kbd{C-u M-d}@}, displays descendancy trees
+With a prefix argument, @{@kbd{C-u M-d}@}, it displays descendancy trees
 for all classes at the current browser level.  They are all grouped
-under some imaginary joining node so as to maintain the concept of one
+under an imaginary root node so as to maintain the concept of one
 tree per xoobr view.
-@kindex M-f
-@findex br-tree-features-toggle
-@cindex xoobr, displaying features
-@cindex descendancy view
-@{@kbd{M-f}@} @code{(br-tree-features-toggle)} is used before creating a
-graphical descendency view to determine whether or not to include the
-features of each class in the listing as child nodes of the class.
-It toggles between showing features and not showing them in descendancy
-views.  The setting applies across all OO-Browser languages.  The
-default setting is to not add features to the view.
 @cindex xoobr, view
 Xoobr views are meant to complement the textual browser interface.
 Therefore, the two most common actions used in the text browser are
 performed in a similar manner within an xoobr view.  A click on a node with
 @node Options, Customization, Usage, Top
 @chapter OO-Browser Options
 @menu
 * External Viewing::            Using An External Viewer or Editor
+* Inherited Features::          Toggling Inherited Features Display
+* Graphical Add Features::      Add Features to a Graphical View
 * Keep Viewed Classes::
 * Inhibit Version::             Inhibit Version Screen
 * Invert Ancestors::            Invert Ancestor Trees
 * Save All::                    Save All Lookup Tables
 * Use Children::                Build Children Lookup Table
 * Sort Options::                Controlling Class Listing Order
 @end menu
-@node External Viewing, Keep Viewed Classes, Options, Options
+@node External Viewing, Inherited Features, Options, Options
 @comment  node-name,  next,  previous,  up
 @section Using an External Viewer or Editor
 @cindex editing, externally
 @cindex viewing, externally
 @display
 @code{(setq br-viewer-cmd "xmore")}
 @end display
-@node Keep Viewed Classes, Inhibit Version, External Viewing, Options
+@node Inherited Features, Graphical Add Features, External Viewing, Options
+@comment  node-name,  next,  previous,  up
+@section Toggling Inherited Features Display
+@cindex inherited features
+@cindex feature options
+By default, when the OO-Browser lists features of a class, it shows both
+the ones lexically defined within the class source text and the ones
+inherited from ancestor classes.  Each feature is listed below the class
+in which it is originally defined, for clarity.  Sometimes it is useful
+to see only the lexically defined features of a class.  In such cases,
+the menu item, @emph{Options/Show-Inherited-Features}, toggles this
+setting.  If you want this on by default, you can add the following
+line to a personal initialization file:
+@display
+@code{(setq br-inherited-features-flag nil)}
+@end display
+@node Graphical Add Features, Keep Viewed Classes, Inherited Features, Options
+@comment  node-name,  next,  previous,  up
+@section Add Features to a Graphical View
+@xref{Graphical Browsing,  , Graphical OO-Browser Interfaces}.
+@node Keep Viewed Classes, Inhibit Version, Graphical Add Features, Options
 @comment  node-name,  next,  previous,  up
 @section Keep Viewed Classes
 @vindex br-keep-viewed-classes
 The @var{br-keep-viewed-classes} flag is turned off by default,
 buffers when you want to trim down the number with which you are dealing.
 @xref{Using the Mouse}, for details on this technique.
 @findex br-toggle-keep-viewed
 @vindex br-keep-viewed-classes
-The value of the @var{br-keep-viewed-classes} flag may be easily
+The value of the @var{br-keep-viewed-classes} flag may be easily toggled
-toggled with the @code{(br-toggle-keep-viewed)} command bound to
+with the @code{(br-toggle-keep-viewed)} command or with the menu item,
-@{@kbd{V}@}.
+@emph{Options/Keep-Viewed-Classes}.
 @node Inhibit Version, Invert Ancestors, Keep Viewed Classes, Options
 @section Inhibit Version Screen
 @vindex br-inhibit-version
-After you are familiar with the opening OO-Browser version screen, you may
+After you are familiar with the opening OO-Browser version and credits
-want to disable its display each time the browser is started.  This is done by
+screen, you may want to disable its display each time the browser is
-setting @var{br-inhibit-version} non-nil, as in the following line that
+started.  This is done by setting @var{br-inhibit-version} non-nil, as
-would go in your personal OO-Browser initialization file:
+in the following line that would go in your personal OO-Browser
+initialization file:
 @example
 	@code{(setq br-inhibit-version t)}
 @end example
 @findex br-version
 @cindex version, browser
 @cindex support
 @noindent
 This option has no effect on the display of the help screen which
-follows the version screen.  Even with this option set, you may display
+is displayed after the version screen.  Even with this option set, you
-the version screen at any time from within a browser listing
+may display the version screen at any time from within a browser listing
 window by using @{@kbd{C-c #}@} @code{(br-version)}.
 @node Invert Ancestors, Save All, Inhibit Version, Options
 @section Invert Ancestor Trees
 @var{c++-include-dirs}, then the directories listed in the variable
 @var{c++-cpp-include-dirs}, and then in any directories included in the
 current environment.  The variable @var{c++-cpp-include-dirs} should
 hold a list of the standard directories searched by your C++ pre-processor.
 Each directory entry must end with a directory separator.  On UNIX
-systems, this is the '/' character.
+systems, this is the `/' character.
 @node C++ Settings,  , C++ Element Selection, C++ Specifics
 @subsection C++ Settings
 @vindex c++-class-keyword
 @cindex class definition keywords
 @node Eiffel Specifics, Java Specifics, CLOS Specifics, Languages
 @section Eiffel Specifics
 Eiffel support has now been updated to Eiffel version 3, to the best
 of our knowledge.  If you find any problems, please report them
-to <oo-browser@@hub.ucsb.edu> (this is a public mailing list).
+to <oo-browser@@infodock.com> (this is a public mailing list).
 @menu
 * Eiffel Listings::
 * Eiffel Element Selection::    Source Code Element Selection
 * Eiffel Settings::
 @node Eiffel Settings,  , Eiffel Element Selection, Eiffel Specifics
 @subsection Eiffel Settings
 @findex eif-get-parents-from-source
-Be sure that the 'inherit' and 'feature' clauses in your classes begin in
+Be sure that the `inherit' and `feature' clauses in your classes begin in
 column 0; otherwise the browser parser will not work properly.  If you prefer
 some other indentation style, you will need to slightly alter
 @code{(eif-get-parents-from-source)} in @file{br-eif.el}; specifically,
-the lines that contain '^inherit' and '^feature'.
+the lines that contain `^inherit' and `^feature'.
 @cindex Eiffel, error parsing
 @cindex error parsing
 Emacs has a feature called error parsing which lets one quickly jump to
 the line of code that supposedly triggered an error.
 @node Java Specifics, Objective-C Specifics, Eiffel Specifics, Languages
 @section Java Specifics
 @cindex Java feature listings
+@cindex Java attribute
+@cindex attribute, Java
+Java attribute names are precededed by @code{"= "} in feature listings.
 @cindex abstract method
 @cindex method, abstract
 @cindex deferred function
 Java abstract method declarations, which specify method interfaces
 but no implementation, appear in class feature listings.  The method
 @var{objc-include-dirs}, then the directories listed in the variable
 @var{objc-cpp-include-dirs}, and then in any directories included in the
 current environment.  The variable @var{objc-cpp-include-dirs} should
 hold a list of the standard directories searched by your Objective-C
 pre-processor.  Each directory entry must end with a directory
-separator.  On UNIX systems, this is the '/' character.
+separator.  On UNIX systems, this is the `/' character.
 @node Objective-C Settings, Python Specifics, Objective-C Element Selection, Objective-C Specifics
 @subsection Objective-C Settings
 @vindex objc-class-keyword
 @cindex class definition keywords
 @node Python Specifics, Python Module Lookup, Objective-C Settings, Languages
 @section Python Specifics
-The OO-Browser supports browsing Python classes, methods, and
+@cindex Python doc strings
-documentation strings for both. The class info key 'i' is used to
+The OO-Browser supports browsing Python classes and methods.
-display class or method documentation string, if that is available.
+Documentation strings for classes or methods may be displayed
+from a listing buffer with the @{@kbd{i}@} key.
-Python methods appear in class feature listings.  The method
-name is preceded by the @code{"- "} string.
+Python method names are preceded by the @code{"- "} string in listing
+buffers.
-Global functions are grouped under the imaginary class @code{[functions]} to
+@cindex Python functions
+Global functions are grouped under the default class @code{[function]} to
 distinguish them from classes or class methods.
-Known bugs: nested classes are not recognized.  As browsing is based on
+Nested classes are not recognized by the browser, nor are run-time
-analyzing the source code, run-time modifications are lost.
+modifications to classes.
 @menu
 * Python Module Lookup::       Source Code Element Selection
 * Python Settings::
 @end menu
 @node Python Module Lookup, Python Settings , Python Specifics, Python Specifics
 @subsection Python Module Lookup
-The @file{br-help-ms} file uses a table format to summarize mouse
+The @file{br-help-ms} file summarizes mouse key operation within the
-control within the browser, it may be displayed within the browser via
+browser.  Use @{@kbd{H}@}, the @code{(br-help-ms)} command, to display
-the @{@kbd{H}@} @code{(br-help-ms)} command.
+this help when point is within a listing window.
-Clicking on a module name in an import statement using the Action Key
+@cindex Python import statement
-will open the specified module, if it is found in the search path.
+An Action Key press on a module name within a Python import statement
+will display the source for the module, if it is found within the
+current Environment.
 @node Python Settings,  , Python Module Lookup, Python Specifics
 @subsection Python Settings
 @vindex python-import-dirs
-@cindex class definition keywords
+A press of the Action Key on an import statement, tries to display the
-When a module name in an import statement is clicked using
+module to be imported.  First, the module is looked up within the
-the Action Key, OO-Browser tries to open the module.py file.  By default,
+current Environment directories.  If not found, the path
-it looks for the module file in the environment directories, and from the path
+@file{/usr/local/lib/python} is searched.  Modify
-@code{/usr/local/lib/python}. If you have installed Python libraries
+the variable, @var{python-import-dirs}, to alter the set of paths
-elsewhere, or wish to include other modules in the search path, you will
+searched after the Environment directories..
-need to modify the definition of @var{python-import-dirs} in
-@file{br-python-ft.el}.
 @c   ***************************
 @c          Appendices
 @c   ***************************
 @appendix OO-Browser Features
 @itemize @bullet
 @item
-Support for Eiffel, C++, Objective-C, Smalltalk, Java and Common Lisp
+Support for C, C++, Common Lisp and its Object System (CLOS), Eiffel,
-and its Object System (CLOS) is included.  Additionally, support for
+Java, Objective-C, Python and Smalltalk class browsing is included.
-browsing large amounts of material in Info format by node name (a
+Additionally, support for browsing large amounts of material in Info
-popular online documentation format with cross references and
+format by node name (a popular online documentation format with cross
-hierarchical structure) is include.  All languages provide class
+references and hierarchical structure) is included.  All languages
-browsing via either a textual or a graphical interface.
+provide class browsing via either a textual or a graphical interface.
 @item
-Method browsing is supported for C++, Objective-C, Eiffel and CLOS.
+Method and typically attribute browsing is supported for all languages
-CLOS supports browsing all elements defined with (def* constructs.
+except Smalltalk.  CLOS supports browsing all elements defined with
-In-source feature browsing is also supported for all of these languages.
+(def* constructs.  In-source feature browsing is also supported for all
-One simply selects a feature name to jump to its corresponding source.
+of these languages.  One simply selects a feature name to jump to its
-Method name overloading in C++ and inherited feature renaming in Eiffel
+corresponding source.  Method name overloading in C++ and inherited
-are fully supported.
+feature renaming in Eiffel are fully supported.
 @item
 C code browsing is supported for C++, Objective-C and C source code.
 @item
 Objective-C category and formal protocol browsing are supported.
 @item
 C++ parameterized template classes and methods are supported.
+@item
+Java abstract and native (externally defined) methods are supported.
 @item
 Building Environments is fast compared to many other tools and browser
 startup once an Environment has been built is very fast.  Response times
 on workstations are excellent; for example, in one test case, less than
 Class files may be added, replaced or deleted one at a time or as a
 group by specifying a root directory below which all class files are
 found, including those in subdirectories.
 @item
-The browser uses class source code only, hence no compiler is necessary for
+The OO-Browser uses class source code only, hence no compiler is
-proper browser operation.
+necessary for proper browser operation.  This allows one to explore
+class libraries without the need for additional tools.
 @item
 Library (stable) and System (in development) classes may be maintained and
 listed separately or together.  Any number of Libraries and Systems may be
 combined for listing in a single Environment.  There are no fixed limits
 @item
 Language-specific class information may be shown.  Presently this feature is
 supported only for Eiffel.  A listing of class parents, attributes,
 routines and best guess (highly accurate) list of routine calls may be
-displayed.  Outputs from the Eiffel 'short' and 'flat' commands may also be
+displayed.  Outputs from the Eiffel `short' and `flat' commands may also be
 shown.
 @item
 Machine-independent mouse support is included along with an extremely
 intuitive point and click interface.  The OO-Browser is pre-configured
 for use with the X window system, NEXTSTEP, Sunview or Apollo's DM
 window system under InfoDock, Emacs V19, XEmacs, Epoch, and Emacs V18.
+Online mouse usage help is always one key away.  (Don't try that level
+of platform independence with Java!)
+@item
+X and NEXTSTEP hierarchy display browsers are included.  They provide
+views of class inheritance structure and lexically included elements,
+which allows for quick random access to entire Environments.  A click on
+a class or element name immediately jumps to it in the editor, providing
+rapid, visual browsing.  One can pop up several graphical browsers to
+gain several views of classes in the same or in multiple environments.
+All graphical browsers can communicate with a single textual browser, so
+one can quickly display and edit classes from different environments
+(even different languages).  Multiple inheritance is handled through
+repetition of nodes throughout the tree; repeated nodes are followed by
+ellipses to indicate multiple inheritance.
 @item
 Popup and pulldown command menus are available under InfoDock, Emacs V19
 and XEmacs.
 Create and save the specification of a new OO-Browser Environment.
 Interactively prompt for the Environment file name or use optional
 ENV-FILE.  Interactively prompt for the Environment language to use or
 use optional LANG-PREFIX as language indicator.  Return the name of the
 Envir spec file created.  Do not build the Environment.  Use
-'br-env-build' to construct an Environment from its specification.
+`br-env-build' to construct an Environment from its specification.
 @findex br-env-load
 @item br-env-load  @{@kbd{C-c C-l}@}
-Load browser Environment or spec from optional ENV-FILE or 'br-env-file'.
+Load browser Environment or spec from optional ENV-FILE or `br-env-file'.
 Non-nil PROMPT means prompt user before building tables.
 Non-nil NO-BUILD means skip build of Environment entirely.
 Return t if load is successful, else nil.
 @findex br-env-rebuild
 Rescan System and Library sources associated with the current Environment.
 @findex br-env-save
 @item br-env-save  @{@kbd{C-c C-s}@}
 Save changed Environment to file given by optional SAVE-FILE or
-'br-env-file'.
+`br-env-file'.
 @findex br-env-stats
 @item br-env-stats  @{@kbd{M-e}@}
 Display summary for current Environment in viewer window.
 With optional prefix ARG, display class totals in minibuffer.
 @item Environment Specification
 Unambiguously tells the browser what to include in the construction of
 an Environment.@refill
 @item Feature
-An element (method/attribute/component) of a class.
+An method, attribute, or other component of a class.  Features may be
+public or private and in some languages, non-inheritable.
 @item Formal Protocol
 See @code{Protocol}.@refill
 @item Implementor

Mercurial > hg > xemacs-beta

comparison man/oo-browser.texi @ 24:4103f0995bd7 r19-15b95