< 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

<docdate>August 28, 2002</docdate>
<doctitle>Document title</doctitle>
<os>Mac OS X</os>
        <name>foo<desc>This is foo's description</desc></name>
        <name>bar<desc>This is bar's description</desc></name>
            <arg>int k<desc>This is a k.</desc></arg>
            <arg>char *b<desc>This is a b.</desc></arg>
        <p>Returns kIONotANumber if you can't count.</p>
        <p>Returns kIOMoron this if you REALLY can't count.</p>
        <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>
        <p>This is a text container, really, but generally contains
        lines like this:</p>
        <manpage>foo<section>1</section>, </manpage> 
        <p>Here's a list of conformance:</p>
            <li>Single UNIX Specification</li>
        <p>Here are some bugs:</p>
                <li>Bug one....</li>
                <li>Bug two....</li>
                <li>Bug three....</li>
        <p>I think that pretty much covers it.</p>

< Previous PageNext Page >

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