| 1 | ;; doc-java.srt --- SRecode templates for "document" applications |
| 2 | |
| 3 | ;; Copyright (C) 2009-2011 Free Software Foundation, Inc. |
| 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 | |
| 22 | set mode "java-mode" |
| 23 | |
| 24 | set application "document" |
| 25 | |
| 26 | context declaration |
| 27 | |
| 28 | ;;; Notes on the DOCUMENT templates. |
| 29 | ;; |
| 30 | ;; These templates recycle existing templates for javadoc in the |
| 31 | ;; more general C++ template set. |
| 32 | |
| 33 | template section-comment :indent :blank |
| 34 | "A comment separating major sections of a file." |
| 35 | ---- |
| 36 | {{>:declaration:javadoc-section-comment}} |
| 37 | ---- |
| 38 | |
| 39 | template function-comment :tag :indent :blank |
| 40 | "A comment occurring in front of a function. |
| 41 | Recycle javadoc comment code from the more general template set." |
| 42 | ---- |
| 43 | {{>:declaration:javadoc-function}} |
| 44 | ---- |
| 45 | |
| 46 | template variable-same-line-comment :tag |
| 47 | "A comment occurring after a veriable declaration. |
| 48 | Recycle javadoc comment code from the more general template set." |
| 49 | ---- |
| 50 | {{>:declaration:javadoc-variable-same-line}} |
| 51 | ---- |
| 52 | |
| 53 | ;; These happen to be the same as in a classdecl. |
| 54 | template group-comment-start :blank :indent |
| 55 | "A comment occurring in front of a group of declarations. |
| 56 | Recycle javadoc comment code from the more general template set." |
| 57 | ---- |
| 58 | {{>:classdecl:javadoc-function-group-start}} |
| 59 | ---- |
| 60 | |
| 61 | template group-comment-end :blank :indent |
| 62 | "A comment occurring at the end of a group of declarations. |
| 63 | Recycle javadoc comment code from the more general template set." |
| 64 | ---- |
| 65 | {{>:classdecl:javadoc-function-group-end}} |
| 66 | ---- |
| 67 | |
| 68 | ;; Some templates only show up in classdecls. |
| 69 | context classdecl |
| 70 | |
| 71 | template group-comment-start :blank :indent |
| 72 | "A comment occurring in front of a group of declarations. |
| 73 | Recycle javadoc comment code from the more general template set." |
| 74 | ---- |
| 75 | {{>:classdecl:javadoc-function-group-start}} |
| 76 | ---- |
| 77 | |
| 78 | template group-comment-end :blank :indent |
| 79 | "A comment occurring at the end of a group of declarations. |
| 80 | Recycle javadoc comment code from the more general template set." |
| 81 | ---- |
| 82 | {{>:classdecl:javadoc-function-group-end}} |
| 83 | ---- |
| 84 | |
| 85 | ;; end |