aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2015-11-04 10:07:25 +0100
committerJuanma Barranquero2015-11-04 10:07:25 +0100
commit587b2328377c32950a7ccf89f7c0b7d95db873af (patch)
tree441895cd10fb1533f0423a6a875a67278fd88b23
parent411b516d65b4e3b88e7b268dac7a32668e8d39c7 (diff)
downloademacs-587b2328377c32950a7ccf89f7c0b7d95db873af.tar.gz
emacs-587b2328377c32950a7ccf89f7c0b7d95db873af.zip
* 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.el12
1 files changed, 6 insertions, 6 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index 7eff1f123b5..329bd9d1462 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -92,7 +92,7 @@ This is typically the filename.")
92Line numbers start from 1 and columns from 0.") 92Line numbers start from 1 and columns from 0.")
93 93
94(defun xref-make-file-location (file line column) 94(defun xref-make-file-location (file line column)
95 "Create and return a new xref-file-location." 95 "Create and return a new `xref-file-location'."
96 (make-instance 'xref-file-location :file file :line line :column column)) 96 (make-instance 'xref-file-location :file file :line line :column column))
97 97
98(cl-defmethod xref-location-marker ((l xref-file-location)) 98(cl-defmethod xref-location-marker ((l xref-file-location))
@@ -117,7 +117,7 @@ Line numbers start from 1 and columns from 0.")
117 (position :type fixnum :initarg :position))) 117 (position :type fixnum :initarg :position)))
118 118
119(defun xref-make-buffer-location (buffer position) 119(defun xref-make-buffer-location (buffer position)
120 "Create and return a new xref-buffer-location." 120 "Create and return a new `xref-buffer-location'."
121 (make-instance 'xref-buffer-location :buffer buffer :position position)) 121 (make-instance 'xref-buffer-location :buffer buffer :position position))
122 122
123(cl-defmethod xref-location-marker ((l xref-buffer-location)) 123(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
138actual location is not known.") 138actual location is not known.")
139 139
140(defun xref-make-bogus-location (message) 140(defun xref-make-bogus-location (message)
141 "Create and return a new xref-bogus-location." 141 "Create and return a new `xref-bogus-location'."
142 (make-instance 'xref-bogus-location :message message)) 142 (make-instance 'xref-bogus-location :message message))
143 143
144(cl-defmethod xref-location-marker ((l xref-bogus-location)) 144(cl-defmethod xref-location-marker ((l xref-bogus-location))
@@ -162,7 +162,7 @@ to the reference's target."))
162somewhere.") 162somewhere.")
163 163
164(defun xref-make (summary location) 164(defun xref-make (summary location)
165 "Create and return a new xref item. 165 "Create and return a new `xref-item'.
166SUMMARY is a short string to describe the xref. 166SUMMARY is a short string to describe the xref.
167LOCATION is an `xref-location'." 167LOCATION is an `xref-location'."
168 (make-instance 'xref-item :summary summary :location location)) 168 (make-instance 'xref-item :summary summary :location location))
@@ -183,7 +183,7 @@ somewhere.")
183 end-column))) 183 end-column)))
184 184
185(defun xref-make-match (summary end-column location) 185(defun xref-make-match (summary end-column location)
186 "Create and return a new xref match item. 186 "Create and return a new `xref-match-item'.
187SUMMARY is a short string to describe the xref. 187SUMMARY is a short string to describe the xref.
188END-COLUMN is the match end column number inside SUMMARY. 188END-COLUMN is the match end column number inside SUMMARY.
189LOCATION is an `xref-location'." 189LOCATION is an `xref-location'."
@@ -633,7 +633,7 @@ meantime are preserved."
633 633
634(defun xref--insert-xrefs (xref-alist) 634(defun xref--insert-xrefs (xref-alist)
635 "Insert XREF-ALIST in the current-buffer. 635 "Insert XREF-ALIST in the current-buffer.
636XREF-ALIST is of the form ((GROUP . (XREF ...)) ...). Where 636XREF-ALIST is of the form ((GROUP . (XREF ...)) ...), where
637GROUP is a string for decoration purposes and XREF is an 637GROUP is a string for decoration purposes and XREF is an
638`xref-item' object." 638`xref-item' object."
639 (require 'compile) ; For the compilation faces. 639 (require 'compile) ; For the compilation faces.