diff options
author | Jeffrey H. Kingston <jeff@it.usyd.edu.au> | 2010-09-14 19:35:24 +0000 |
---|---|---|
committer | Jeffrey H. Kingston <jeff@it.usyd.edu.au> | 2010-09-14 19:35:24 +0000 |
commit | d4b68bb27f42afb8338f35f9fda0c467ec5d8787 (patch) | |
tree | 26e8947ef0a82e8150e46ebd0b257ec5cd13c0ed /doc/user/cpp_comm | |
parent | 2c0ebbabd66ba21d3224bf58678bf62998b94c2c (diff) | |
download | lout-d4b68bb27f42afb8338f35f9fda0c467ec5d8787.tar.gz |
Lout 3.18.
git-svn-id: http://svn.savannah.nongnu.org/svn/lout/trunk@5 9365b830-b601-4143-9ba8-b4a8e2c3339c
Diffstat (limited to 'doc/user/cpp_comm')
-rw-r--r-- | doc/user/cpp_comm | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/doc/user/cpp_comm b/doc/user/cpp_comm index f877c06..96ac110 100644 --- a/doc/user/cpp_comm +++ b/doc/user/cpp_comm @@ -1,20 +1,27 @@ @Section - @Title { Lout inside C comments } + @Title { Embedding Lout commands within program comments } @Tag { cpcomm } @Begin @PP -It is possible to embed Lout text inside C and C++ comments, by -starting off the comment with an @Code "@" character. The entire -comment after the @Code "@" character should be Lout text. For -example, to force Lout to start a new page at some point within a C -program, place +It is possible to embed Lout text inside program comments. How this +is done could in principle vary from language to language, but in +every language supported so far it is done by starting off the comment +with an @Code "@" character. If the language has several ways to get +a comment, this will work every way. The entire comment after the @Code "@" +character should then be Lout text. For example, to force Lout to start +a new page at some point within a C program, place @ID @Code "/*@ @NP */" -at that point. Or you could make a heading like this: -@ID @Code "/*@ @Display @Heading { treeprint() } */" -Other possible uses for this feature include index entries and margin -notes. Incredible as it may seem, you can even write +at that point. (In this case you can also simply include a formfeed +formfeed. @Index { formfeed in program texts } +character, control-L, without any comment; whatever the language, a formfeed +in program text is taken to be a request to start a new page.) Or, to +make a heading in an Eiffel program, do this: +@ID @Code "--@ @Display @Heading { treeprint() }" +(Eiffel comments begin with @Code "--" and end at the end of the +line.) Other possible uses for this feature include index entries and +margin notes. Incredible as it may seem, you can even write @ID @Code "/*@ @CD @Heading { Function @CP { treeprint() } } */" with a @Code "@CP" symbol and some C code inside the Lout code -inside the C code. You probably can't go further, however, since -that would require a C comment inside a C comment. +inside the C code. You probably can't go further, however, at least +not in C, since that would require a C comment inside a C comment. @End @Section |