Add bug number.

[gnu-emacs] / lisp / cedet / semantic / doc.el

diff --git a/lisp/cedet/semantic/doc.el b/lisp/cedet/semantic/doc.el
index 9018449721f2c0df844404c33e7ed89179b88d29..c8a3c12e1b24d9b5df05efa3062bd3ab34314206 100644 (file)
--- a/lisp/cedet/semantic/doc.el
+++ b/lisp/cedet/semantic/doc.el
@@ -1,7 +1,7 @@
-;;; doc.el --- Routines for documentation strings
+;;; semantic/doc.el --- Routines for documentation strings
 
-;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009
-;;; Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009, 2010
+;;   Free Software Foundation, Inc.
 
 ;; Author: Eric M. Ludlam <zappo@gnu.org>
 ;; Keywords: syntax
@@ -23,7 +23,7 @@
 
 ;;; Commentary:
 ;;
-;; It is good practice to write documenation for your functions and
+;; It is good practice to write documentation for your functions and
 ;; variables.  These core routines deal with these documentation
 ;; comments or strings.  They can exist either as a tag property
 ;; (:documentation) or as a comment just before the symbol, or after
@@ -33,6 +33,7 @@
 
 ;;; Code:
 
+;;;###autoload
 (define-overloadable-function semantic-documentation-for-tag (&optional tag nosnarf)
   "Find documentation from TAG and return it as a clean string.
 TAG might have DOCUMENTATION set in it already.  If not, there may be
@@ -60,10 +61,11 @@ If nosnarf if 'lex, then only return the lex token."
          ;; Not sure yet.  Fill in something clever later....
          nil))))))
 
+;; FIXME this is not how you spell "preceding".
 (defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf)
-  "Find a comment preceeding TAG.
+  "Find a comment preceding TAG.
 If TAG is nil.  use the tag under point.
-Searches the space between TAG and the preceeding tag for a comment,
+Searches the space between TAG and the preceding tag for a comment,
 and converts the comment into clean documentation.
 Optional argument NOSNARF with a value of 'lex means to return
 just the lexical token and not the string."
@@ -82,9 +84,6 @@ just the lexical token and not the string."
        (semantic-doc-snarf-comment-for-tag nosnarf)))
     ))
 
-(make-obsolete-overload 'semantic-find-documentation
-                        'semantic-documentation-for-tag)
-
 (defun semantic-doc-snarf-comment-for-tag (nosnarf)
   "Snarf up the comment at POINT for `semantic-documentation-for-tag'.
 Attempt to strip out comment syntactic sugar.
@@ -120,9 +119,12 @@ If NOSNARF is 'lex, then return the lex token."
        ;; Now return the text.
        ct))))
 
-(semantic-alias-obsolete 'semantic-find-documentation
-                         'semantic-documentation-for-tag)
-
 (provide 'semantic/doc)
 
-;;; semantic-doc.el ends here
+;; Local variables:
+;; generated-autoload-file: "loaddefs.el"
+;; generated-autoload-load-name: "semantic/doc"
+;; End:
+
+;; arch-tag: fe6e965b-4a81-4304-aab8-22ca113194ca
+;;; semantic/doc.el ends here