annotate oldXMenu/Error.c @ 111851:dd83cbcddf69

Adjust parameter names and doc strings to resolve confusion over whether "bookmark" meant a bookmark name or a bookmark record. Along the way, shorten one function's name for similar reasons. (Issue #7548) * lisp/bookmark.el (bookmark-name-from-record): New name for `bookmark-name-from-full-record'. All callers changed. (bookmark-get-bookmark, bookmark-get-bookmark-record, bookmark-default-annotation-text, bookmark-prop-get, bookmark-prop-set, bookmark-get-annotation, bookmark-set-annotation, bookmark-get-filename, bookmark-set-filename, bookmark-get-position, bookmark-set-position, bookmark-get-front-context-string, bookmark-set-front-context-string, bookmark-get-rear-context-string, bookmark-set-rear-context-string, bookmark-get-handler, bookmark-edit-annotation, bookmark--jump-via, bookmark-handle-bookmark, bookmark-location, bookmark-show-annotation): Rename `bookmark' parameter to `bookmark-name-or-record', to clearly show its role, and shorten or adjust doc strings accordingly. (bookmark-set-name): Same, and pass the parameter directly to `bookmark-get-bookmark' instead of redundantly doing the callee's work. (bookmark-default-annotation-text, bookmark-send-edited-annotation, bookmark-relocate, bookmark-insert-location, bookmark-insert, bookmark-delete): Rename `bookmark' parameter to `bookmark-name', and in some cases shorten doc string accordingly. (bookmark-rename): Change `old' and `new' parameters to `old-name' and `new-name', and adjust an internal variable to avoid confusion. (bookmark-jump, bookmark-jump-noselect): Clarify `bookmark' parameter in doc string.
author Karl Fogel <kfogel@red-bean.com>
date Wed, 08 Dec 2010 03:09:27 -0500
parents 5cc91198ffb2
children ef719132ddfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
76174
fec5e03aaf59 Remove FSF copyright since file does not differ significantly from X11
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
1 /* Copyright Massachusetts Institute of Technology 1985 */
fec5e03aaf59 Remove FSF copyright since file does not differ significantly from X11
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
2
25858
Dave Love <fx@gnu.org>
parents:
diff changeset
3 #include "copyright.h"
Dave Love <fx@gnu.org>
parents:
diff changeset
4
Dave Love <fx@gnu.org>
parents:
diff changeset
5
Dave Love <fx@gnu.org>
parents:
diff changeset
6 /*
Dave Love <fx@gnu.org>
parents:
diff changeset
7 * XMenu: MIT Project Athena, X Window system menu package
Dave Love <fx@gnu.org>
parents:
diff changeset
8 *
Dave Love <fx@gnu.org>
parents:
diff changeset
9 * XMenuError - Returns a string description of the current
Dave Love <fx@gnu.org>
parents:
diff changeset
10 * XMenu error status flag.
Dave Love <fx@gnu.org>
parents:
diff changeset
11 *
Dave Love <fx@gnu.org>
parents:
diff changeset
12 * Author: Tony Della Fera, DEC
Dave Love <fx@gnu.org>
parents:
diff changeset
13 * August, 1985
Dave Love <fx@gnu.org>
parents:
diff changeset
14 *
Dave Love <fx@gnu.org>
parents:
diff changeset
15 */
Dave Love <fx@gnu.org>
parents:
diff changeset
16
Dave Love <fx@gnu.org>
parents:
diff changeset
17 #include "XMenuInt.h"
Dave Love <fx@gnu.org>
parents:
diff changeset
18
Dave Love <fx@gnu.org>
parents:
diff changeset
19 char *
109124
5cc91198ffb2 Convert function definitions in oldXMenu to standard C.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 76174
diff changeset
20 XMenuError(void)
25858
Dave Love <fx@gnu.org>
parents:
diff changeset
21 {
Dave Love <fx@gnu.org>
parents:
diff changeset
22 static char message[128]; /* Error message buffer. */
Dave Love <fx@gnu.org>
parents:
diff changeset
23
Dave Love <fx@gnu.org>
parents:
diff changeset
24 if ((_XMErrorCode < XME_CODE_COUNT) && (_XMErrorCode >= 0)) {
Dave Love <fx@gnu.org>
parents:
diff changeset
25 return(_XMErrorList[_XMErrorCode]);
Dave Love <fx@gnu.org>
parents:
diff changeset
26 }
Dave Love <fx@gnu.org>
parents:
diff changeset
27 sprintf(message, "Unknown _XMErrorCode: %d", _XMErrorCode);
Dave Love <fx@gnu.org>
parents:
diff changeset
28 return(message);
Dave Love <fx@gnu.org>
parents:
diff changeset
29 }
Dave Love <fx@gnu.org>
parents:
diff changeset
30
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 25858
diff changeset
31 /* arch-tag: 5fff4a23-40ca-40d0-8887-c50fc73dea9d
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 25858
diff changeset
32 (do not change this comment) */