< Previous PageNext Page >


A Simple Function Example

Listing 1-1 is an example of how to write an MPGL manual page for a function.

Listing 5-1 A simple MPGL example for a function

<manpage>
<docdate>August 28, 2002</docdate>
<doctitle>Document title</doctitle>
<os>Mac OS X</os>
<section>3</section>
<names>
        <name>foo<desc>This is foo's description</desc></name>
        <name>bar<desc>This is bar's description</desc></name>
</names>
<usage>
        <func><type>int</type><name>foo</name>
            <arg>int k<desc>This is a k.</desc></arg>
            <arg>char *b<desc>This is a b.</desc></arg>
        </func>
</usage>
<returnvalues>
        <p>Returns kIONotANumber if you can't count.</p>
        <p>Returns kIOMoron this if you REALLY can't count.</p>
</returnvalues>
<environment>
        TEXT
</environment>
<files>
        <file>/path/to/filename<desc>This is a waste of time</desc></file>
        <file>/path/to/another/filename<desc>This is also a waste of time</desc></file>
</files>
<examples>
        TEXT
</examples>
<diagnostics>
        TEXT
</diagnostics>
<errors>
        TEXT
</errors>
<seealso>
        <p>This is a text container, really, but generally contains
        lines like this:</p>
        <manpage>foo<section>1</section>, </manpage> 
        <manpage>bar<section>3</section></manpage>
</seealso>
<conformingto>
        <p>Here's a list of conformance:</p>
        <ul>
            <li>Single UNIX Specification</li>
            <li>POSIX</li>
        </ul>
</conformingto>
<history>
        TEXT
</history>
<bugs>
        <p>Here are some bugs:</p>
        <p>
        <ol>
                <li>Bug one....</li>
                <li>Bug two....</li>
                <li>Bug three....</li>
        </ol>
        </p>
        <p>I think that pretty much covers it.</p>
</bugs>
</manpage>


< Previous PageNext Page >


© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)