diff options
author | Juanma Barranquero <lekktu@gmail.com> | 2015-11-04 10:07:25 +0100 |
---|---|---|
committer | Juanma Barranquero <lekktu@gmail.com> | 2015-11-04 10:07:25 +0100 |
commit | 587b2328377c32950a7ccf89f7c0b7d95db873af (patch) | |
tree | 441895cd10fb1533f0423a6a875a67278fd88b23 | |
parent | 411b516d65b4e3b88e7b268dac7a32668e8d39c7 (diff) |
* lisp/progmodes/xref.el: Doc fixes
(xref-make-file-location, xref-make-buffer-location, xref-make)
(xref-make-bogus-location, xref-make-match): Add cross-references.
(xref--insert-xrefs): Fix typo in docstring.
-rw-r--r-- | lisp/progmodes/xref.el | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 7eff1f123b..329bd9d146 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -92,7 +92,7 @@ This is typically the filename.") Line numbers start from 1 and columns from 0.") (defun xref-make-file-location (file line column) - "Create and return a new xref-file-location." + "Create and return a new `xref-file-location'." (make-instance 'xref-file-location :file file :line line :column column)) (cl-defmethod xref-location-marker ((l xref-file-location)) @@ -117,7 +117,7 @@ Line numbers start from 1 and columns from 0.") (position :type fixnum :initarg :position))) (defun xref-make-buffer-location (buffer position) - "Create and return a new xref-buffer-location." + "Create and return a new `xref-buffer-location'." (make-instance 'xref-buffer-location :buffer buffer :position position)) (cl-defmethod xref-location-marker ((l xref-buffer-location)) @@ -138,7 +138,7 @@ indicate errors, e.g. when we know that a function exists but the actual location is not known.") (defun xref-make-bogus-location (message) - "Create and return a new xref-bogus-location." + "Create and return a new `xref-bogus-location'." (make-instance 'xref-bogus-location :message message)) (cl-defmethod xref-location-marker ((l xref-bogus-location)) @@ -162,7 +162,7 @@ to the reference's target.")) somewhere.") (defun xref-make (summary location) - "Create and return a new xref item. + "Create and return a new `xref-item'. SUMMARY is a short string to describe the xref. LOCATION is an `xref-location'." (make-instance 'xref-item :summary summary :location location)) @@ -183,7 +183,7 @@ somewhere.") end-column))) (defun xref-make-match (summary end-column location) - "Create and return a new xref match item. + "Create and return a new `xref-match-item'. SUMMARY is a short string to describe the xref. END-COLUMN is the match end column number inside SUMMARY. LOCATION is an `xref-location'." @@ -633,7 +633,7 @@ meantime are preserved." (defun xref--insert-xrefs (xref-alist) "Insert XREF-ALIST in the current-buffer. -XREF-ALIST is of the form ((GROUP . (XREF ...)) ...). Where +XREF-ALIST is of the form ((GROUP . (XREF ...)) ...), where GROUP is a string for decoration purposes and XREF is an `xref-item' object." (require 'compile) ; For the compilation faces. |