comparison lisp/cedet/semantic/doc.el @ 105340:118ad0cdd9a8

Doc/message fixes.
author Glenn Morris <rgm@gnu.org>
date Thu, 01 Oct 2009 04:54:05 +0000
parents bbd7017a25d9
children 7f4c7f5c0eba
comparison
equal deleted inserted replaced
105339:adbff0886e10 105340:118ad0cdd9a8
1 ;;; semantic/doc.el --- Routines for documentation strings 1 ;;; semantic/doc.el --- Routines for documentation strings
2 2
3 ;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009 3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009
4 ;;; Free Software Foundation, Inc. 4 ;; Free Software Foundation, Inc.
5 5
6 ;; Author: Eric M. Ludlam <zappo@gnu.org> 6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Keywords: syntax 7 ;; Keywords: syntax
8 8
9 ;; This file is part of GNU Emacs. 9 ;; This file is part of GNU Emacs.
21 ;; You should have received a copy of the GNU General Public License 21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. 22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 23
24 ;;; Commentary: 24 ;;; Commentary:
25 ;; 25 ;;
26 ;; It is good practice to write documenation for your functions and 26 ;; It is good practice to write documentation for your functions and
27 ;; variables. These core routines deal with these documentation 27 ;; variables. These core routines deal with these documentation
28 ;; comments or strings. They can exist either as a tag property 28 ;; comments or strings. They can exist either as a tag property
29 ;; (:documentation) or as a comment just before the symbol, or after 29 ;; (:documentation) or as a comment just before the symbol, or after
30 ;; the symbol on the same line. 30 ;; the symbol on the same line.
31 31
59 (semantic-documentation-comment-preceeding-tag tag nosnarf)) 59 (semantic-documentation-comment-preceeding-tag tag nosnarf))
60 ;; Lets look for comments either after the definition, but before code: 60 ;; Lets look for comments either after the definition, but before code:
61 ;; Not sure yet. Fill in something clever later.... 61 ;; Not sure yet. Fill in something clever later....
62 nil)))))) 62 nil))))))
63 63
64 ;; FIXME this is not how you spell "preceding".
64 (defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf) 65 (defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf)
65 "Find a comment preceeding TAG. 66 "Find a comment preceding TAG.
66 If TAG is nil. use the tag under point. 67 If TAG is nil. use the tag under point.
67 Searches the space between TAG and the preceeding tag for a comment, 68 Searches the space between TAG and the preceding tag for a comment,
68 and converts the comment into clean documentation. 69 and converts the comment into clean documentation.
69 Optional argument NOSNARF with a value of 'lex means to return 70 Optional argument NOSNARF with a value of 'lex means to return
70 just the lexical token and not the string." 71 just the lexical token and not the string."
71 (if (not tag) (setq tag (semantic-current-tag))) 72 (if (not tag) (setq tag (semantic-current-tag)))
72 (save-excursion 73 (save-excursion