diff options
| author | David Aspinall | 1998-11-25 13:02:59 +0000 |
|---|---|---|
| committer | David Aspinall | 1998-11-25 13:02:59 +0000 |
| commit | 1e0c252b5290ab160969c266025289b952eb239f (patch) | |
| tree | 14a38f8a88ccfacf3ab9354b923429522b9b3ad1 /generic | |
| parent | e6860a080a4dcc3cbd43c5fbf1904eae0ba190cd (diff) | |
Documentation improvements.
Diffstat (limited to 'generic')
| -rw-r--r-- | generic/proof-site.el | 4 | ||||
| -rw-r--r-- | generic/texi-docstring-magic.el | 21 |
2 files changed, 14 insertions, 11 deletions
diff --git a/generic/proof-site.el b/generic/proof-site.el index d597f374..e5e6183e 100644 --- a/generic/proof-site.el +++ b/generic/proof-site.el @@ -53,9 +53,9 @@ assistant, `SYMBOL-mode', run when files with AUTOMODE-REGEXP are visited. SYMBOL is also used to form the name of the directory and elisp file for the mode, which will be - <proof-home-directory>/SYMBOL/SYMBOL.el + PROOF-HOME-DIRECTORY/SYMBOL/SYMBOL.el -where `<proof-home-directory>/' is the value of the +where `PROOF-HOME-DIRECTORY' is the value of the variable proof-home-directory." :type '(repeat (list symbol string string)) :group 'proof-general-internals) diff --git a/generic/texi-docstring-magic.el b/generic/texi-docstring-magic.el index 05e125f5..2c05d08d 100644 --- a/generic/texi-docstring-magic.el +++ b/generic/texi-docstring-magic.el @@ -60,15 +60,7 @@ ("\\(\\*\\(\\w+\\)\\*\\)" t (concat "@strong{" (match-string 2 docstring) "}")) - ;; 4. Upper cased words ARG corresponding to arguments become @var{arg} - ;; In fact, include any word so long as it is more than 3 characters - ;; long. - ("\\([A-Z0-9\\-]+\\)\\(\)\\|\\s-\\|\\s.\\|$\\)" - (or (> (length (match-string 1 docstring)) 3) - (member (downcase (match-string 1 docstring)) args)) - (concat "@var{" (downcase (match-string 1 docstring)) "}" - (match-string 2 docstring))) - ;; 6. Words sym which are symbols become @code{sym}. + ;; 4. Words sym which are symbols become @code{sym}. ;; Must have at least one hyphen to be recognized, ;; terminated in whitespace, end of line, or punctuation. ;; (Only consider symbols made from word constituents @@ -78,6 +70,17 @@ (fboundp (intern (match-string 2 docstring)))) (concat "@code{" (match-string 2 docstring) "}" (match-string 4 docstring))) + ;; 5. Upper cased words ARG corresponding to arguments become + ;; @var{arg} + ;; In fact, include any word so long as it is more than 3 characters + ;; long. (Comes after symbols to avoid recognizing the + ;; lowercased form of an argument as a symbol) + ("\\([A-Z0-9\\-]+\\)\\(/\\|-\\|\)\\|}\\|\\s-\\|\\s.\\|$\\)" + (or (> (length (match-string 1 docstring)) 3) + (member (downcase (match-string 1 docstring)) args)) + (concat "@var{" (downcase (match-string 1 docstring)) "}" + (match-string 2 docstring))) + ;; 7. Words 'sym which are lisp quoted are ;; marked with @code. ("\\(\\(\\s-\\|^\\)'\\(\\(\\w\\|\\-\\)+\\)\\)\\(\\s\)\\|\\s-\\|\\s.\\|$\\)" |