changeset 99053:926c8689e999

(sexp-at-point, symbol-at-point, number-at-point, list-at-point): Add docstrings.
author Chong Yidong <cyd@stupidchicken.com>
date Wed, 22 Oct 2008 20:51:23 +0000
parents 969002d1b897
children 731804a3fbe8
files lisp/thingatpt.el
diffstat 1 files changed, 10 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/thingatpt.el	Wed Oct 22 20:50:29 2008 +0000
+++ b/lisp/thingatpt.el	Wed Oct 22 20:51:23 2008 +0000
@@ -437,15 +437,22 @@
     (if (or (not pred) (funcall pred sexp)) sexp)))
 
 ;;;###autoload
-(defun sexp-at-point ()   (form-at-point 'sexp))
+(defun sexp-at-point ()
+  "Return the sexp at point, or nil if none is found."
+  (form-at-point 'sexp))
 ;;;###autoload
 (defun symbol-at-point ()
+  "Return the symbol at point, or nil if none is found."
   (let ((thing (thing-at-point 'symbol)))
     (if thing (intern thing))))
 ;;;###autoload
-(defun number-at-point () (form-at-point 'sexp 'numberp))
+(defun number-at-point ()
+  "Return the number at point, or nil if none is found."
+  (form-at-point 'sexp 'numberp))
 ;;;###autoload
-(defun list-at-point ()   (form-at-point 'list 'listp))
+(defun list-at-point ()
+  "Return the Lisp list at point, or nil if none is found."
+  (form-at-point 'list 'listp))
 
 ;; arch-tag: bb65a163-dae2-4055-aedc-fe11f497f698
 ;;; thingatpt.el ends here