X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/1259009aa17da6dc038afff96963f6d9bbd3b8e1..c8109d9c4057d8cac79e2c139758cadd410e7446:/doc/misc/sem-user.texi diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index 1984d69a69..a8684a40b3 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi @@ -1,13 +1,7 @@ -@c This file is included by semantic.texi - -@c Copyright (C) 1999-2005, 2007, 2009-2012 Free Software Foundation, Inc. - -@c Permission is granted to copy, distribute and/or modify this -@c document under the terms of the GNU Free Documentation License, -@c Version 1.3 or any later version published by the Free Software -@c Foundation; with no Invariant Sections, no Front-Cover Texts, and -@c no Back-Cover Texts. A copy of the license is included in the -@c section entitled ``GNU Free Documentation License''. +@c This is part of the Semantic manual. +@c Copyright (C) 1999-2005, 2007, 2009-2016 Free Software Foundation, +@c Inc. +@c See file semantic.texi for copying conditions. You can begin using @semantic{} by enabling Semantic mode, a global minor mode: type @kbd{M-x semantic-mode}, or open the @samp{Tools} @@ -31,7 +25,7 @@ File,,,emacs,Emacs manual}. * Analyzer:: Semantic tools for analyzing code. * Speedbar:: Using @semantic{} with the Speedbar. * SymRef:: Interface to symbol reference tools. -* MRU Bookmarks:: Managing tag ``bookmarks''. +* MRU Bookmarks:: Managing tag "bookmarks". * Sticky Func Mode:: Showing declarations in the header line. * Highlight Func Mode:: Highlight the current function declaration. * Tag Decoration Mode:: Minor mode to decorate tags. @@ -59,7 +53,7 @@ minor modes. The variable @code{semantic-default-submodes} determines which auxiliary modes are enabled; the defaults are SemanticDB mode (@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode (@pxref{Idle Scheduler}). You can also toggle the auxiliary minor -modes separately, using their mode functions (e.g. @kbd{M-x +modes separately, using their mode functions (e.g., @kbd{M-x semanticdb-minor-mode}), or via the @samp{Development} menu. The various auxiliary minor modes are described in the following sections. @@ -105,7 +99,7 @@ valid mode symbols are: Semantic mode provides a number of commands for navigating, querying, and editing source code in a language-aware manner. These commands generally act on @dfn{tags}, which are the source-code units deemed -``important'' by the present programming language (e.g. functions in +``important'' by the present programming language (e.g., functions in the C programming language). These commands may be used in any buffer that has been parsed by @@ -176,7 +170,7 @@ Copy the current tag into a register kill it as well. This allows you to insert or jump to that tag with the usual register commands. @xref{Registers,,,emacs,Emacs manual}. -@item \C-c , @kbd{up} +@item C-c , @kbd{up} Transpose the current tag with the previous one (@code{senator-transpose-tags-up}). @@ -277,7 +271,7 @@ variable. This allows SemanticDB to save tag caches in directories controlled by them. @end defvar -@deffn Option semanticdb-save-database-hooks +@deffn Option semanticdb-save-database-functions Abnormal hook run after a database is saved. Each function is called with one argument, the object representing the database recently written. @@ -422,11 +416,11 @@ Customize the system include path for the current major mode (or @var{mode}). @end deffn -@defun semanticdb-implied-include-tags +@defvar semanticdb-implied-include-tags Include tags implied for all files of a given mode. You can set this variable with @code{defvar-mode-local} for a particular mode so that any symbols that exist for all files for that mode are included. -@end defun +@end defvar @c @xref{Search Optimization}, for more information on include paths. @@ -489,9 +483,9 @@ for them once, which will be used over and over for tools such as summary-mode, or the analyzer. @deffn Command semanticdb-create-ebrowse-database dir -Create an @var{ebrowse} database for directory @var{dir}. -The database file is stored in ~/.semanticdb, or whichever directory -is specified by @code{semanticdb-default-system-save-directory}. +Create an Ebrowse database for directory @var{dir}. The database file +is stored in ~/.semanticdb, or whichever directory is specified by +@code{semanticdb-default-system-save-directory}. @end deffn @node Idle Scheduler @@ -909,12 +903,12 @@ at a given buffer position. The return value is an EIEIO object describing the context at @var{pos} (@pxref{Top,,,eieio,EIEIO manual}). -When called interactively, this displays a @samp{*Semantic Context +When called interactively, this displays a @file{*Semantic Context Analysis*} buffer containing a summary of the context at point. @end deffn @noindent -The Prefix section of the @samp{*Semantic Context Analysis*} buffer +The Prefix section of the @file{*Semantic Context Analysis*} buffer lists the tags based on the text at point. If it shows only a simple string, the Semantic was unable to identify what the data type was. @@ -989,7 +983,7 @@ If your symbol should be in the scope, but you cannot find it, then you may have found a language support bug in the local-variable parser, or using statement parser. -Calling @kbd{M-x bovinte} should force a reset on the scope in case +Calling @kbd{M-x bovinate} should force a reset on the scope in case there is merely some bad state. @example @@ -1020,7 +1014,7 @@ fully qualified names. You can examine the typecache with @kbd{M-x semanticdb-typecache-dump}. If your data types are not in the typecache, there may be some parsing -error or other bug. Calling @kbd{M-x bovinte} should force a reset on +error or other bug. Calling @kbd{M-x bovinate} should force a reset on the typecache in case there is merely some bad state. @example @@ -1179,7 +1173,7 @@ the declaration line of the function or tag on the topmost line in the text area. This allows you to keep that declaration line in view at all times, even if it is scrolls off the ``top'' of the screen. -In addition, clicking @kbd{Mouse-1} on the header line opens a context +In addition, clicking @kbd{mouse-1} on the header line opens a context menu that contains menu items for copying, killing, or narrowing to that tag. @@ -1205,7 +1199,7 @@ Semantic Highlight Function minor mode highlights the declaration line of the current function or tag (that is to say, the first line that describes the rest of the construct). -In addition, clicking @kbd{Mouse-3} on the highlighted declaration +In addition, clicking @kbd{mouse-3} on the highlighted declaration line opens a context menu that contains menu items for copying, killing, or narrowing to that tag. @@ -1309,7 +1303,7 @@ You can create new types of decorations using the following function: Define a new decoration style with @var{name}. @var{doc} is a documentation string describing the decoration style @var{name}. It is appended to auto-generated doc strings. -An Optional list of @var{flags} can also be specified. Flags are: +An optional list of @var{flags} can also be specified. Flags are: @code{:enabled} - specify the default enabled value for @var{name}.