annotate etc/srecode/doc-default.srt @ 109478:2660703dfff3

* PROBLEMS: Add note about use of backslashes in Windows paths.

;; doc-default.srt --- SRecode templates for "document" applications

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

;; Author: Eric M. Ludlam <[e-mail]>

;; 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 <http://www.gnu.org/licenses/>.

set mode "default"

set application "document"

context declaration

template section-comment :blank :indent
"A comment occurring in front of a group of declarations."
----
{{comment_start}} {{?TITLE}}
{{comment_prefix}}
{{comment_prefix}} {{^}}
{{comment_end}}
----

template function-comment :tag :indent :blank
"A comment occurring in front of a function."
----
{{comment_start}} {{?NAME}} --
{{DOC:srecode-comment-prefix}}
{{comment_end}}
----

template variable-same-line-comment :tag
"A comment occurring after a veriable declaration."
----
{{comment_start}} {{?DOC}} {{comment_end}}
----

;; 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."
----
{{comment_start}} {{?GROUPNAME}} --
{{comment_end}}
----

template group-comment-end :indent
"A comment occurring at the end of a group of declarations."
----
{{comment_start}} End {{?GROUPNAME}} {{comment_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."
----
{{>:declaration:group-comment-start}}
----

template group-comment-end :indent
"A comment occurring at the end of a group of declarations."
----
{{>:declaration:group-comment-end}}
----

;; end