doc-cpp.srt 2.56 KB
Newer Older
1 2
;; doc-c.srt --- SRecode templates for "document" applications

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2008-2019 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

;; Author: Eric M. Ludlam <eric@siege-engine.com>

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
20
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
21

David Engster's avatar
David Engster committed
22
set mode "c-mode"
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

set application "document"
context declaration

;;; Notes on the DOCUMENT templates.
;;
;; These templates recycle existing templates for doxygen in the
;; more general C++ template set.

template section-comment :indent :blank
"A comment separating major sections of a file."
----
{{>:declaration:doxygen-section-comment}}
----

template function-comment :tag :indent :blank
39
"A comment occurring in front of a function.
40 41 42 43 44 45
Recycle doxygen comment code from the more general template set."
----
{{>:declaration:doxygen-function}}
----

template variable-same-line-comment :tag
Paul Eggert's avatar
Paul Eggert committed
46
"A comment occurring after a variable declaration.
47 48 49 50 51 52 53
Recycle doxygen comment code from the more general template set."
----
{{>:declaration:doxygen-variable-same-line}}
----

;; These happen to be the same as in a classdecl.
template group-comment-start :blank :indent
54
"A comment occurring in front of a group of declarations.
55 56 57 58 59 60
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-start}}
----

template group-comment-end :blank :indent
61
"A comment occurring at the end of a group of declarations.
62 63 64 65 66 67 68 69 70
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-end}}
----

;; Some templates only show up in classdecls.
context classdecl

template group-comment-start :blank :indent
71
"A comment occurring in front of a group of declarations.
72 73 74 75 76 77
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-start}}
----

template group-comment-end :blank :indent
78
"A comment occurring at the end of a group of declarations.
79 80 81 82 83 84
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-end}}
----

;; end