Add 2012 to FSF copyright years for Emacs files (do not merge to trunk)
[bpt/emacs.git] / etc / srecode / doc-cpp.srt
CommitLineData
c05676c5
CY
1;; doc-c.srt --- SRecode templates for "document" applications
2
49f70d46 3;; Copyright (C) 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
c05676c5
CY
4
5;; Author: Eric M. Ludlam <eric@siege-engine.com>
6
7;; This file is part of GNU Emacs.
8
9;; GNU Emacs is free software: you can redistribute it and/or modify
10;; it under the terms of the GNU General Public License as published by
11;; the Free Software Foundation, either version 3 of the License, or
12;; (at your option) any later version.
13
14;; GNU Emacs is distributed in the hope that it will be useful,
15;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17;; GNU General Public License for more details.
18
19;; You should have received a copy of the GNU General Public License
20;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21
22set mode "c++-mode"
23
24set application "document"
25context declaration
26
27;;; Notes on the DOCUMENT templates.
28;;
29;; These templates recycle existing templates for doxygen in the
30;; more general C++ template set.
31
32template section-comment :indent :blank
33"A comment separating major sections of a file."
34----
35{{>:declaration:doxygen-section-comment}}
36----
37
38template function-comment :tag :indent :blank
c2dd1910 39"A comment occurring in front of a function.
c05676c5
CY
40Recycle doxygen comment code from the more general template set."
41----
42{{>:declaration:doxygen-function}}
43----
44
45template variable-same-line-comment :tag
c2dd1910 46"A comment occurring after a veriable declaration.
c05676c5
CY
47Recycle doxygen comment code from the more general template set."
48----
49{{>:declaration:doxygen-variable-same-line}}
50----
51
52;; These happen to be the same as in a classdecl.
53template group-comment-start :blank :indent
c2dd1910 54"A comment occurring in front of a group of declarations.
c05676c5
CY
55Recycle doxygen comment code from the more general template set."
56----
57{{>:classdecl:doxygen-function-group-start}}
58----
59
60template group-comment-end :blank :indent
045b9da7 61"A comment occurring at the end of a group of declarations.
c05676c5
CY
62Recycle doxygen comment code from the more general template set."
63----
64{{>:classdecl:doxygen-function-group-end}}
65----
66
67;; Some templates only show up in classdecls.
68context classdecl
69
70template group-comment-start :blank :indent
c2dd1910 71"A comment occurring in front of a group of declarations.
c05676c5
CY
72Recycle doxygen comment code from the more general template set."
73----
74{{>:classdecl:doxygen-function-group-start}}
75----
76
77template group-comment-end :blank :indent
045b9da7 78"A comment occurring at the end of a group of declarations.
c05676c5
CY
79Recycle doxygen comment code from the more general template set."
80----
81{{>:classdecl:doxygen-function-group-end}}
82----
83
84;; end