mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-27 10:54:40 +00:00
Minor English and formatting changes.
This commit is contained in:
parent
2394fd2118
commit
9105187020
@ -94,9 +94,9 @@ software support for two things:
|
||||
@item
|
||||
When you get a new class library, or you have to work on source code you
|
||||
haven't written yourself (or written sufficiently long ago), you need a
|
||||
tool letting you navigate through class hierarchies and investigate
|
||||
features of the software. Without such a tool you often end up grep'ing
|
||||
through dozens or even hundreds of files.
|
||||
tool to let you navigate class hierarchies and investigate
|
||||
features of the software. Without such a tool you often end up
|
||||
@command{grep}ing through dozens or even hundreds of files.
|
||||
|
||||
@item
|
||||
Once you are productive, it would be nice to have a tool that knows your
|
||||
@ -113,7 +113,7 @@ How does it work?
|
||||
@cindex parser for C++ sources
|
||||
A fast parser written in C is used to process C++ source files.
|
||||
The parser generates a data base containing information about classes,
|
||||
members, global functions, defines, types etc. found in the sources.
|
||||
members, global functions, defines, types etc.@: found in the sources.
|
||||
|
||||
The second part of Ebrowse is a Lisp program. This program reads
|
||||
the data base generated by the parser. It displays its contents in
|
||||
@ -138,20 +138,20 @@ displayed as a member list of its own:
|
||||
|
||||
@itemize @bullet
|
||||
@item
|
||||
Instance member variables,
|
||||
Instance member variables;
|
||||
|
||||
@item
|
||||
Instance member functions,
|
||||
Instance member functions;
|
||||
|
||||
@item
|
||||
Static member variables,
|
||||
Static member variables;
|
||||
|
||||
@item
|
||||
Static member functions,
|
||||
Static member functions;
|
||||
|
||||
@item
|
||||
Friends/Defines, The list of defines is contained in the friends
|
||||
list of the pseudo-class @samp{*Globals*}.
|
||||
Friends/Defines. The list of defines is contained in the friends
|
||||
list of the pseudo-class @samp{*Globals*};
|
||||
|
||||
@item
|
||||
Types (@code{enum}s, and @code{typedef}s defined with class
|
||||
@ -269,7 +269,7 @@ of a command pipe.
|
||||
|
||||
@findex --search-path
|
||||
@item --search-path=@var{paths}
|
||||
This option let's you specify search paths for your input files.
|
||||
This option lets you specify search paths for your input files.
|
||||
@var{paths} is a list of directory names, separated from each other by a
|
||||
either a colon or a semicolon, depending on the operating system.
|
||||
@end table
|
||||
@ -328,7 +328,7 @@ append its output to an existing file with this command line option.
|
||||
This switch suppresses all classes in the data base declared as
|
||||
@code{struct} or @code{union} in the output.
|
||||
|
||||
This is mainly thought for the case that you are converting an existing
|
||||
This is mainly useful when you are converting an existing
|
||||
C program to C++, and do not want to see the old C structs in a class
|
||||
tree.
|
||||
@end table
|
||||
@ -343,7 +343,7 @@ tree.
|
||||
@cindex regular expressions, recording
|
||||
The parser @command{ebrowse} normally writes regular expressions to its
|
||||
output file that help the Lisp part of Ebrowse to find functions,
|
||||
variables etc. in their source files.
|
||||
variables etc.@: in their source files.
|
||||
|
||||
You can instruct @command{ebrowse} to omit these regular expressions by
|
||||
calling it with the command line switch @samp{--no-regexps}.
|
||||
@ -357,7 +357,7 @@ coding styles are used.
|
||||
@table @samp
|
||||
@findex --no-regexps
|
||||
@item --no-regexps
|
||||
This option turns regular expression recording off.
|
||||
This option turns off regular expression recording.
|
||||
|
||||
@findex --min-regexp-length
|
||||
@cindex minimum regexp length for recording
|
||||
@ -367,7 +367,7 @@ the regular expressions recorded to match class and member declarations
|
||||
and definitions. The default value is set at compilation time of
|
||||
@command{ebrowse}.
|
||||
|
||||
The smaller the minimum length the higher the probability that
|
||||
The smaller the minimum length, the higher the probability that
|
||||
Ebrowse will find a wrong match. The larger the value, the
|
||||
larger the output file and therefore the memory consumption once the
|
||||
file is read from Emacs.
|
||||
@ -380,10 +380,10 @@ regular expressions used to match class and member declarations and
|
||||
definitions. The default value is set at compilation time of
|
||||
@command{ebrowse}.
|
||||
|
||||
The larger the maximum length the higher the probability that the
|
||||
The larger the maximum length, the higher the probability that the
|
||||
browser will find a correct match, but the larger the value the larger
|
||||
the output file and therefore the memory consumption once the data is
|
||||
read. As a second effect, the larger the regular expression the higher
|
||||
read. As a second effect, the larger the regular expression, the higher
|
||||
the probability that it will no longer match after editing the file.
|
||||
@end table
|
||||
|
||||
@ -460,7 +460,7 @@ where no highlight is displayed.
|
||||
|
||||
Class trees are displayed in @dfn{tree buffers} which install their own
|
||||
major mode. Most Emacs keys work in tree buffers in the usual way,
|
||||
e.g., you can move around in the buffer with the usual @kbd{C-f},
|
||||
e.g.@: you can move around in the buffer with the usual @kbd{C-f},
|
||||
@kbd{C-v} etc., or you can search with @kbd{C-s}.
|
||||
|
||||
Tree-specific commands are bound to simple keystrokes, similar to
|
||||
@ -681,7 +681,7 @@ cursor is on.
|
||||
|
||||
@item +
|
||||
This command expands the branch of the tree starting at the class the
|
||||
cursor is on. Both commands for collapsing and expanding branches are
|
||||
cursor is on. Both commands for collapsing and expanding branches are
|
||||
also available from the class' object menu.
|
||||
|
||||
@item *
|
||||
@ -700,7 +700,7 @@ This command expands all collapsed branches in the tree.
|
||||
@table @kbd
|
||||
@item T w
|
||||
This command reads a new indentation width from the minibuffer and
|
||||
redisplays the tree buffer with the new indentation. It is also
|
||||
redisplays the tree buffer with the new indentation It is also
|
||||
available from the tree buffer's context menu.
|
||||
@end table
|
||||
|
||||
@ -733,8 +733,8 @@ deletion is actually performed.
|
||||
|
||||
@table @kbd
|
||||
@item C-x C-s
|
||||
This command writes a class tree to the file it was read from. This is
|
||||
useful after classes have been deleted from a tree.
|
||||
This command writes a class tree to the file from which it was read.
|
||||
This is useful after classes have been deleted from a tree.
|
||||
|
||||
@item C-x C-w
|
||||
Writes the tree to a file whose name is read from the minibuffer.
|
||||
@ -814,15 +814,15 @@ Ebrowse distinguishes six kinds of lists:
|
||||
|
||||
@itemize @bullet
|
||||
@item
|
||||
Instance variables (normal member variables),
|
||||
Instance variables (normal member variables);
|
||||
@item
|
||||
Instance functions (normal member functions),
|
||||
Instance functions (normal member functions);
|
||||
@item
|
||||
Static variables,
|
||||
Static variables;
|
||||
@item
|
||||
Static member functions,
|
||||
Static member functions;
|
||||
@item
|
||||
Friend functions,
|
||||
Friend functions;
|
||||
@item
|
||||
Types (@code{enum}s and @code{typedef}s defined with class scope.
|
||||
Nested classes will be shown in the class tree like normal classes.
|
||||
@ -888,7 +888,7 @@ Switch to the list of static member variables.
|
||||
Switch to the list of friends or defines.
|
||||
|
||||
@item L t
|
||||
Switch to the list of types.x
|
||||
Switch to the list of types.
|
||||
@end table
|
||||
|
||||
Both commands cycle through the member list.
|
||||
@ -947,7 +947,7 @@ displayed when clicking @kbd{mouse-2} on a member name.
|
||||
@table @kbd
|
||||
@item D b
|
||||
This command toggles the display of inherited members in the member
|
||||
buffer. This is also in the buffer's context menu.
|
||||
buffer. This is also in the buffer's context menu.
|
||||
@end table
|
||||
|
||||
|
||||
@ -966,12 +966,12 @@ list.
|
||||
|
||||
@item G m
|
||||
Like the above command, but all members for the current class appear in
|
||||
the completion list. If necessary, the current member list is switched
|
||||
the completion list. If necessary, the current member list is switched
|
||||
to the one containing the member.
|
||||
|
||||
With a prefix argument (@kbd{C-u}), all members in the class tree,
|
||||
i.e., all members the browser knows about appear in the completion
|
||||
list. The member display will be switched to the class and member list
|
||||
i.e.@: all members the browser knows about appear in the completion
|
||||
list. The member display will be switched to the class and member list
|
||||
containing the member.
|
||||
|
||||
@item G n
|
||||
@ -1350,7 +1350,7 @@ This command sets point to the previous position in the position stack.
|
||||
Directly after you performed a jump, this will put you back to the
|
||||
position where you came from.
|
||||
|
||||
The stack is not popped, i.e., you can always switch back and forth
|
||||
The stack is not popped, i.e.@: you can always switch back and forth
|
||||
between positions in the stack. To avoid letting the stack grow to
|
||||
infinite size there is a maximum number of positions defined. When this
|
||||
number is reached, older positions are discarded when new positions are
|
||||
@ -1362,7 +1362,7 @@ the next position stored in the position stack.
|
||||
|
||||
@item C-c b p
|
||||
Displays an electric buffer showing all positions saved in the stack.
|
||||
You can select a position by pressing @kbd{SPC} in a line. You can
|
||||
You can select a position by pressing @kbd{SPC} in a line. You can
|
||||
view a position with @kbd{v}.
|
||||
@end table
|
||||
|
||||
@ -1397,7 +1397,7 @@ selected in the usual way with completion.
|
||||
Perform a query replace over the set of files.
|
||||
|
||||
@item C-c b ,
|
||||
All three operations above stop when finding a match. You can restart
|
||||
All three operations above stop when finding a match. You can restart
|
||||
the operation with this command.
|
||||
|
||||
@item C-c b n
|
||||
@ -1432,7 +1432,7 @@ given regular expression. This command can be very useful if you
|
||||
remember only part of a member name, and not its beginning.
|
||||
|
||||
A special buffer is popped up containing all identifiers matching the
|
||||
regular expression, and what kind of symbol it is (e.g., a member
|
||||
regular expression, and what kind of symbol it is (e.g.@: a member
|
||||
function, or a type). You can then switch to this buffer, and use the
|
||||
command @kbd{C-c b f}, for example, to jump to a specific member.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user