summaryrefslogtreecommitdiff
path: root/etc/srecode/doc-java.srt
blob: b4a76d1f85d1ee3e423c66179b2a4c6c7dfb45f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
;; doc-java.srt --- SRecode templates for "document" applications

;; Copyright (C) 2009-2018 Free Software Foundation, Inc.

;; 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
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.

set mode "java-mode"

set application "document"

context declaration

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

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

template function-comment :tag :indent :blank
"A comment occurring in front of a function.
Recycle javadoc comment code from the more general template set."
----
{{>:declaration:javadoc-function}}
----

template variable-same-line-comment :tag
"A comment occurring after a variable declaration.
Recycle javadoc comment code from the more general template set."
----
{{>:declaration:javadoc-variable-same-line}}
----

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

template group-comment-end :blank :indent
"A comment occurring at the end of a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-end}}
----

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

template group-comment-start :blank :indent
"A comment occurring in front of a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-start}}
----

template group-comment-end :blank :indent
"A comment occurring at the end of a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-end}}
----

;; end