etc/srecode/doc-default.srt

   1 ;; doc-default.srt --- SRecode templates for "document" applications
   2
   3 ;; Copyright (C) 2009-2018 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 <https://www.gnu.org/licenses/>.
  21
  22 set mode "default"
  23
  24 set application "document"
  25
  26 context declaration
  27
  28 template section-comment :blank :indent
  29 "A comment occurring in front of a group of declarations."
  30 ----
  31 {{comment_start}} {{?TITLE}}
  32 {{comment_prefix}}
  33 {{comment_prefix}} {{^}}
  34 {{comment_end}}
  35 ----
  36
  37 template function-comment :tag :indent :blank
  38 "A comment occurring in front of a function."
  39 ----
  40 {{comment_start}} {{?NAME}} --
  41 {{DOC:srecode-comment-prefix}}
  42 {{comment_end}}
  43 ----
  44
  45 template variable-same-line-comment :tag
  46 "A comment occurring after a variable declaration."
  47 ----
  48 {{comment_start}} {{?DOC}} {{comment_end}}
  49 ----
  50
  51 ;; These happen to be the same as in a classdecl.
  52 template group-comment-start :blank :indent
  53 "A comment occurring in front of a group of declarations."
  54 ----
  55 {{comment_start}} {{?GROUPNAME}} --
  56 {{comment_end}}
  57 ----
  58
  59 template group-comment-end :indent
  60 "A comment occurring at the end of a group of declarations."
  61 ----
  62 {{comment_start}} End {{?GROUPNAME}} {{comment_end}}
  63 ----
  64
  65 ;; Some templates only show up in classdecls.
  66 context classdecl
  67
  68 template group-comment-start :blank :indent
  69 "A comment occurring in front of a group of declarations."
  70 ----
  71 {{>:declaration:group-comment-start}}
  72 ----
  73
  74 template group-comment-end :indent
  75 "A comment occurring at the end of a group of declarations."
  76 ----
  77 {{>:declaration:group-comment-end}}
  78 ----
  79
  80 ;; end