* mdoc.5: Document //code/@src attribute.

svn path=/trunk/mono/; revision=131156

diff --git a/man/ChangeLog b/man/ChangeLog
index be6bd901b54298164b218fe26cbec6028552a467..73999bd25ee1eb04e60c45e0754334c81592a07d 100644 (file)
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,3 +1,7 @@
+2009-04-06  Jonathan Pryor  <jpryor@novell.com>
+
+       * mdoc.5: Document //code/@src attribute.
+
 2009-04-03  Andrés G. Aragoneses  <aaragoneses@novell.com>
 
        * monolinker.1: Document -m modifier.

diff --git a/man/mdoc.5 b/man/mdoc.5
index bcf1268212e5031e32ac8a34326a70436c1b9171..9690445ce583ca1f5fb9265c43eeb8c9200e70b2 100644 (file)
--- a/man/mdoc.5
+++ b/man/mdoc.5
@@ -328,13 +328,26 @@ The \fIc\fR element can contain the following elements:
 \fIsee\fR, and
 \fItypeparamref\fR.
 .TP
-.I <code lang="LANGUAGE">TEXT</code>
+.I <code lang="LANGUAGE" src="SOURCE">TEXT</code>
 Display multiple lines of text in a code-like font (similar to the HTML <pre/>
 element).
+.Sp
 .I LANGUAGE
 is the language this code block is for.  For example, if \fILANGUAGE\fR is
 \fBC#\fR, then \fITEXT\fR will get syntax highlighting for the C# language 
 within the Mono Documentation Browser.
+.Sp
+.I SOURCE
+is only interpreted by \fBmdoc-update\fR(1).  If the \fIsrc\fR attribute is
+present when \fBmdoc-update\fR(1) is run, then \fISOURCE\fR is a file 
+(relative to \fBmdoc-update\fR(1)'s \fB--out\fR directory) that
+should be inserted as the value for \fITEXT\fR.
+The contents of \fITEXT\fR will be ignored by \fBmdoc-update\fR(1)
+and replaced on every invocation.  \fISOURCE\fR can also contain an "anchor",
+e.g. \fIsrc="path/to/file.cs#RegionMarker"\fR.  If an anchor is present,
+\fIand\fR \fILANGUAGE\fR is \fIC#\fR, then \fI#region RegionMarker\fR will be
+searched for, and the contents between the \fI#region\fR and the following
+\fI#endregion\fR will be inserted as the value for \fITEXT\fR element.
 .TP
 .I <example>XML_TEXT</example>
 Indicates an example that should be displayed specially.  For example: