annotate etc/srecode/doc-cpp.srt @ 105917:510f457168de

* emacs-lisp/checkdoc.el (checkdoc-proper-noun-regexp): Match noun at end of sentence (my Bug#4818).
author Kevin Ryde <user42@zip.com.au>
date Sun, 08 Nov 2009 21:48:43 +0000
parents 84fc40980c51
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
1 ;; doc-c.srt --- SRecode templates for "document" applications
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
2
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
3 ;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
4
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
6
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
7 ;; This file is part of GNU Emacs.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
8
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
10 ;; it under the terms of the GNU General Public License as published by
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
11 ;; the Free Software Foundation, either version 3 of the License, or
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
12 ;; (at your option) any later version.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
13
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
14 ;; GNU Emacs is distributed in the hope that it will be useful,
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
17 ;; GNU General Public License for more details.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
18
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
21
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
22 set mode "c++-mode"
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
23
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
24 set application "document"
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
25 context declaration
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
26
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
27 ;;; Notes on the DOCUMENT templates.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
28 ;;
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
29 ;; These templates recycle existing templates for doxygen in the
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
30 ;; more general C++ template set.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
31
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
32 template section-comment :indent :blank
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
33 "A comment separating major sections of a file."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
34 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
35 {{>:declaration:doxygen-section-comment}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
36 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
37
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
38 template function-comment :tag :indent :blank
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
39 "A comment occuring in front of a function.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
40 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
41 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
42 {{>:declaration:doxygen-function}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
43 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
44
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
45 template variable-same-line-comment :tag
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
46 "A comment occuring after a veriable declaration.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
47 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
48 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
49 {{>:declaration:doxygen-variable-same-line}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
50 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
51
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
52 ;; These happen to be the same as in a classdecl.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
53 template group-comment-start :blank :indent
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
54 "A comment occuring in front of a group of declarations.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
55 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
56 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
57 {{>:classdecl:doxygen-function-group-start}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
58 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
59
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
60 template group-comment-end :blank :indent
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
61 "A comment occuring at the end of a a group of declarations.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
62 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
63 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
64 {{>:classdecl:doxygen-function-group-end}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
65 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
66
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
67 ;; Some templates only show up in classdecls.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
68 context classdecl
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
69
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
70 template group-comment-start :blank :indent
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
71 "A comment occuring in front of a group of declarations.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
72 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
73 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
74 {{>:classdecl:doxygen-function-group-start}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
75 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
76
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
77 template group-comment-end :blank :indent
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
78 "A comment occuring at the end of a a group of declarations.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
79 Recycle doxygen comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
80 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
81 {{>:classdecl:doxygen-function-group-end}}
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
82 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
83
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
84 ;; end