From 2f4268e5e02216be53cd85816362191373512463 Mon Sep 17 00:00:00 2001
From: "Jeffrey H. Kingston" <jeff@it.usyd.edu.au>
Date: Tue, 14 Sep 2010 20:36:01 +0000
Subject: Lout 3.20.

git-svn-id: http://svn.savannah.nongnu.org/svn/lout/trunk@9 9365b830-b601-4143-9ba8-b4a8e2c3339c
---
 doc/user/prg_prog | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 doc/user/prg_prog

(limited to 'doc/user/prg_prog')

diff --git a/doc/user/prg_prog b/doc/user/prg_prog
new file mode 100644
index 0000000..8d343f6
--- /dev/null
+++ b/doc/user/prg_prog
@@ -0,0 +1,35 @@
+@Section
+   @Title { Embedding program text within program comments }
+   @Tag { cpp_prog }
+@Begin
+@PP
+The standard reference for the Eiffel language @Cite { $meyer1992eiffel }
+specifies that identifiers within comments may or should be enclosed
+in ` and ' so that they may be noticed and printed in an italic
+font:
+@ID @Code @Verbatim {
+@ID @Eiffel {
+deposit(amount: REAL) is
+        -- deposit `amount' dollars
+}
+}
+produces
+@ID @Eiffel {
+deposit(amount: REAL) is
+	-- deposit `amount' dollars
+}
+This has been generalized in Lout:  arbitrary text within an
+Eiffel comment between ` and ' will be treated as Eiffel text and
+printed accordingly.  Some other languages may also offer this
+feature:  see the fifth column of the table at the start of this
+chapter.  In principle the precise means of getting it could vary
+from language to language, but the languages available at the moment
+either do not have it at all, or else they use ` and ' like Eiffel.
+@PP
+On the subject of Eiffel, the Eiffel reference @Cite { $meyer1992eiffel }
+has some quite detailed style guidelines, and these have been closely
+followed in the implementation of the @Code "@Eiffel" symbol.  In
+particular, @Code "@Eiffel" prints dots larger than usual when they
+denote feature calls, as the example @OneCol @Eiffel { account.deposit(20) }
+shows.
+@End @Section
-- 
cgit