summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShaun McCance <shaunm@gnome.org>2009-05-02 18:27:26 -0500
committerShaun McCance <shaunm@gnome.org>2009-05-02 18:27:26 -0500
commit3e51d08b7294093f710e384db89ffc19a404e5e9 (patch)
tree0efba4c71d12e3b74f402825ecee107fc69bf2dc
parent6b43e99cfbe6c0e1cb419f8b46a45c146a3d364a (diff)
downloadgnome-doc-utils-3e51d08b7294093f710e384db89ffc19a404e5e9.tar.gz
[mallard] Added note to code about using inside listing
-rw-r--r--doc/mallard/C/mal_block_code.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/mallard/C/mal_block_code.xml b/doc/mallard/C/mal_block_code.xml
index 017179a..99e0817 100644
--- a/doc/mallard/C/mal_block_code.xml
+++ b/doc/mallard/C/mal_block_code.xml
@@ -61,6 +61,11 @@ by the user.</p>
<item><p>The <code>code</code> element may also be used in an inline context.
See <link xref="mal_inline_code"/> for more information.</p></item>
+
+ <item><p>Use the <code>code</code> element inside a
+ <code xref="mal_block_listing">listing</code> element to provide a title
+ and description for the code block. This is frequently used to provide
+ the name of the file whose contents are being shown.</p></item>
</list>
</section>
<!-- END notes -->