annotate etc/srecode/doc-java.srt @ 112416:f792eb37d0ca

* net/rcirc.el (rcirc-kill-buffer-hook): Flush logs.
author Deniz Dogan <deniz.a.m.dogan@gmail.com>
date Sat, 22 Jan 2011 17:21:38 +0100
parents 376148b31b5e
children
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-java.srt --- SRecode templates for "document" applications
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
2
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106860
diff changeset
3 ;; Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
105407
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 "java-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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
26 context declaration
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
27
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
28 ;;; Notes on the DOCUMENT templates.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
29 ;;
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
30 ;; These templates recycle existing templates for javadoc in the
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
31 ;; more general C++ template set.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
32
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
33 template section-comment :indent :blank
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
34 "A comment separating major sections of a file."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
35 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
36 {{>:declaration:javadoc-section-comment}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
39 template function-comment :tag :indent :blank
106838
77b6f5126a69 Fix typos in template docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
40 "A comment occurring in front of a function.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
41 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
42 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
43 {{>:declaration:javadoc-function}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
46 template variable-same-line-comment :tag
106838
77b6f5126a69 Fix typos in template docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
47 "A comment occurring after a veriable declaration.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
48 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
49 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
50 {{>:declaration:javadoc-variable-same-line}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
53 ;; 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
54 template group-comment-start :blank :indent
106838
77b6f5126a69 Fix typos in template docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
55 "A comment occurring in front of a group of declarations.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
56 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
57 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
58 {{>:classdecl:javadoc-function-group-start}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
61 template group-comment-end :blank :indent
106860
4cf58c2379f4 Mario Lang <mlang@delysid.org>: Remove some duplicated words.
Glenn Morris <rgm@gnu.org>
parents: 106838
diff changeset
62 "A comment occurring at the end of a group of declarations.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
63 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
64 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
65 {{>:classdecl:javadoc-function-group-end}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
68 ;; Some templates only show up in classdecls.
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
69 context classdecl
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
70
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
71 template group-comment-start :blank :indent
106838
77b6f5126a69 Fix typos in template docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
72 "A comment occurring in front of a group of declarations.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
73 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
74 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
75 {{>:classdecl:javadoc-function-group-start}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
78 template group-comment-end :blank :indent
106860
4cf58c2379f4 Mario Lang <mlang@delysid.org>: Remove some duplicated words.
Glenn Morris <rgm@gnu.org>
parents: 106838
diff changeset
79 "A comment occurring at the end of a group of declarations.
105407
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
80 Recycle javadoc comment code from the more general template set."
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
81 ----
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
82 {{>:classdecl:javadoc-function-group-end}}
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
84fc40980c51 * srecode: New directory for SRecode template files.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
85 ;; end