Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
M
mxml
Project overview
Project overview
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Armando I. Rivera
mxml
Commits
dc87d4ad
Commit
dc87d4ad
authored
May 31, 2017
by
Michael Sweet
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add @exclude format@ directive.
parent
703c0c99
Changes
4
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
182 additions
and
89 deletions
+182
-89
CHANGES.md
CHANGES.md
+4
-0
doc/mxml.man
doc/mxml.man
+1
-1
doc/mxmldoc.html
doc/mxmldoc.html
+16
-1
mxmldoc.c
mxmldoc.c
+161
-87
No files found.
CHANGES.md
View file @
dc87d4ad
...
...
@@ -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
...
...
doc/mxml.man
View file @
dc87d4ad
.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
...
...
doc/mxmldoc.html
View file @
dc87d4ad
...
...
@@ -65,6 +65,16 @@ create a man page instead of HTML documentation, for example:</p>
>
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>
...
...
mxmldoc.c
View file @
dc87d4ad
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment