Mercurial > emacs
annotate lisp/cedet/semantic/doc.el @ 105377:7f4c7f5c0eba
Add arch tagline
author | Miles Bader <miles@gnu.org> |
---|---|
date | Fri, 02 Oct 2009 10:53:34 +0000 |
parents | 118ad0cdd9a8 |
children | 83dde921cc1b |
rev | line source |
---|---|
104442
b22b44e953cb
cedet/semantic/chart.el: Don't require semantic/find.
Chong Yidong <cyd@stupidchicken.com>
parents:
104421
diff
changeset
|
1 ;;; semantic/doc.el --- Routines for documentation strings |
104421 | 2 |
105340 | 3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009 |
4 ;; Free Software Foundation, Inc. | |
104421 | 5 |
6 ;; Author: Eric M. Ludlam <zappo@gnu.org> | |
7 ;; Keywords: syntax | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software: you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation, either version 3 of the License, or | |
14 ;; (at your option) any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
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/>. | |
23 | |
24 ;;; Commentary: | |
25 ;; | |
105340 | 26 ;; It is good practice to write documentation for your functions and |
104421 | 27 ;; variables. These core routines deal with these documentation |
28 ;; comments or strings. They can exist either as a tag property | |
29 ;; (:documentation) or as a comment just before the symbol, or after | |
30 ;; the symbol on the same line. | |
31 | |
32 (require 'semantic/tag) | |
33 | |
34 ;;; Code: | |
35 | |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
36 ;;;###autoload |
104421 | 37 (define-overloadable-function semantic-documentation-for-tag (&optional tag nosnarf) |
38 "Find documentation from TAG and return it as a clean string. | |
39 TAG might have DOCUMENTATION set in it already. If not, there may be | |
40 some documentation in a comment preceding TAG's definition which we | |
41 can look for. When appropriate, this can be overridden by a language specific | |
42 enhancement. | |
43 Optional argument NOSNARF means to only return the lexical analyzer token for it. | |
44 If nosnarf if 'lex, then only return the lex token." | |
45 (if (not tag) (setq tag (semantic-current-tag))) | |
46 (save-excursion | |
47 (when (semantic-tag-with-position-p tag) | |
48 (set-buffer (semantic-tag-buffer tag))) | |
49 (:override | |
50 ;; No override. Try something simple to find documentation nearby | |
51 (save-excursion | |
52 (semantic-go-to-tag tag) | |
53 (let ((doctmp (semantic-tag-docstring tag (current-buffer)))) | |
54 (or | |
55 ;; Is there doc in the tag??? | |
56 doctmp | |
57 ;; Check just before the definition. | |
58 (when (semantic-tag-with-position-p tag) | |
59 (semantic-documentation-comment-preceeding-tag tag nosnarf)) | |
60 ;; Lets look for comments either after the definition, but before code: | |
61 ;; Not sure yet. Fill in something clever later.... | |
62 nil)))))) | |
63 | |
105340 | 64 ;; FIXME this is not how you spell "preceding". |
104421 | 65 (defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf) |
105340 | 66 "Find a comment preceding TAG. |
104421 | 67 If TAG is nil. use the tag under point. |
105340 | 68 Searches the space between TAG and the preceding tag for a comment, |
104421 | 69 and converts the comment into clean documentation. |
70 Optional argument NOSNARF with a value of 'lex means to return | |
71 just the lexical token and not the string." | |
72 (if (not tag) (setq tag (semantic-current-tag))) | |
73 (save-excursion | |
74 ;; Find this tag. | |
75 (semantic-go-to-tag tag) | |
76 (let* ((starttag (semantic-find-tag-by-overlay-prev | |
77 (semantic-tag-start tag))) | |
78 (start (if starttag | |
79 (semantic-tag-end starttag) | |
80 (point-min)))) | |
81 (when (re-search-backward comment-start-skip start t) | |
82 ;; We found a comment that doesn't belong to the body | |
83 ;; of a function. | |
84 (semantic-doc-snarf-comment-for-tag nosnarf))) | |
85 )) | |
86 | |
87 (defun semantic-doc-snarf-comment-for-tag (nosnarf) | |
88 "Snarf up the comment at POINT for `semantic-documentation-for-tag'. | |
89 Attempt to strip out comment syntactic sugar. | |
90 Argument NOSNARF means don't modify the found text. | |
91 If NOSNARF is 'lex, then return the lex token." | |
92 (let* ((semantic-ignore-comments nil) | |
93 (semantic-lex-analyzer #'semantic-comment-lexer)) | |
94 (if (memq nosnarf '(lex flex)) ;; keep `flex' for compatibility | |
95 (car (semantic-lex (point) (1+ (point)))) | |
96 (let ((ct (semantic-lex-token-text | |
97 (car (semantic-lex (point) (1+ (point))))))) | |
98 (if nosnarf | |
99 nil | |
100 ;; ok, try to clean the text up. | |
101 ;; Comment start thingy | |
102 (while (string-match (concat "^\\s-*" comment-start-skip) ct) | |
103 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
104 (substring ct (match-end 0))))) | |
105 ;; Arbitrary punctuation at the beginning of each line. | |
106 (while (string-match "^\\s-*\\s.+\\s-*" ct) | |
107 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
108 (substring ct (match-end 0))))) | |
109 ;; End of a block comment. | |
110 (if (and (boundp 'block-comment-end) | |
111 block-comment-end | |
112 (string-match block-comment-end ct)) | |
113 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
114 (substring ct (match-end 0))))) | |
115 ;; In case it's a real string, STRIPIT. | |
116 (while (string-match "\\s-*\\s\"+\\s-*" ct) | |
117 (setq ct (concat (substring ct 0 (match-beginning 0)) | |
118 (substring ct (match-end 0)))))) | |
119 ;; Now return the text. | |
120 ct)))) | |
121 | |
122 (provide 'semantic/doc) | |
123 | |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
124 ;; Local variables: |
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
125 ;; generated-autoload-file: "loaddefs.el" |
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
126 ;; generated-autoload-feature: semantic/loaddefs |
104447
273e528a9f9b
* emacs-lisp/autoload.el (generated-autoload-load-name): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
104444
diff
changeset
|
127 ;; generated-autoload-load-name: "semantic/doc" |
104444
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
128 ;; End: |
2bf481006ba4
lisp/Makefile.in: Ignore CEDET subdirectories when making subdirs.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
104442
diff
changeset
|
129 |
105377 | 130 ;; arch-tag: fe6e965b-4a81-4304-aab8-22ca113194ca |
104442
b22b44e953cb
cedet/semantic/chart.el: Don't require semantic/find.
Chong Yidong <cyd@stupidchicken.com>
parents:
104421
diff
changeset
|
131 ;;; semantic/doc.el ends here |