diff options
Diffstat (limited to 'doc/user/cpp_comm')
| -rw-r--r-- | doc/user/cpp_comm | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/user/cpp_comm b/doc/user/cpp_comm new file mode 100644 index 0000000..f877c06 --- /dev/null +++ b/doc/user/cpp_comm @@ -0,0 +1,20 @@ +@Section + @Title { Lout inside C 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 +@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 +@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. +@End @Section |