Commit dc87d4ad authored by Michael Sweet's avatar Michael Sweet

Add @exclude format@ directive.

parent 703c0c99
......@@ -16,6 +16,10 @@
- The mxmldoc utility scanned and loaded descriptive text differently, causing
the detailed descriptions ("discussion") to be lost in generated
documentation.
- The mxmldoc utility now supports `@exclude format@` comments to exclude
documentation based on the output format. The format string can be `all` to
exclude documentation for all formats or a comma-delimited list such as
`@exclude man,html@`.
# Changes in Mini-XML 2.10
......
.TH mxml 3 "Mini-XML API" "05/09/17" "Mini-XML API"
.TH mxml 3 "Mini-XML API" "05/31/17" "Mini-XML API"
.SH NAME
mxml \- Mini-XML API
.SH INCLUDE FILE
......
......@@ -65,6 +65,16 @@ create a man page instead of HTML documentation, for example:</p>
&gt;filename.man ENTER</kbd>
</pre>
<h3>Creating EPUB Books</h3>
<p>The <tt>--epub filename.epub</tt> option tells <tt>mxmldoc</tt> to
create an EPUB book containing the HTML documentation, for example:</p>
<pre>
<kbd>mxmldoc --epub foo.epub *.h *.c foo.xml ENTER</kbd>
</pre>
<h3>Creating Xcode Documentation Sets</h3>
<p>The <tt>--docset directory.docset</tt> option tells <tt>mxmldoc</tt> to
......@@ -75,7 +85,7 @@ example:</p>
<kbd>mxmldoc --docset foo.docset *.h *.c foo.xml ENTER</kbd>
</pre>
<p>Xcode documentation sets can only be built on Mac OS X with Xcode 3.0 or
<p>Xcode documentation sets can only be built on macOS with Xcode 3.0 or
higher installed.</p>
......@@ -148,6 +158,11 @@ following special <tt>@name ...@</tt> directive strings:</p>
<li><tt>@deprecated@</tt> - flags the item as deprecated to
discourage its use</li>
<li><tt>@exclude format[,...,format]@</tt> - excludes the item from the
documentation in the specified formats: "all" for all formats, "docset"
for Xcode documentation sets, "epub" for EPUB books, "html" for HTML
output, and "man" for man page output</li>
<li><tt>@private@</tt> - flags the item as private so it
will not be included in the documentation</li>
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment