mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-13 23:35:30 +00:00
58 lines
2.0 KiB
HTML
58 lines
2.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Mini-XML Programmers Manual, Version 2.0</TITLE>
|
|
<META NAME="author" CONTENT="Michael Sweet">
|
|
<META NAME="copyright" CONTENT="Copyright 2003-2004">
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
|
|
<LINK REL="Start" HREF="index.html">
|
|
<LINK REL="Contents" HREF="toc.html">
|
|
<LINK REL="Prev" HREF="CodeDocumentationConventions.html">
|
|
<LINK REL="Next" HREF="VariablesandClassStructureUnionMembers.html">
|
|
<STYLE TYPE="text/css"><!--
|
|
BODY { font-family: serif }
|
|
H1 { font-family: sans-serif }
|
|
H2 { font-family: sans-serif }
|
|
H3 { font-family: sans-serif }
|
|
H4 { font-family: sans-serif }
|
|
H5 { font-family: sans-serif }
|
|
H6 { font-family: sans-serif }
|
|
SUB { font-size: smaller }
|
|
SUP { font-size: smaller }
|
|
PRE { font-family: monospace }
|
|
--></STYLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<A HREF="toc.html">Contents</A>
|
|
<A HREF="CodeDocumentationConventions.html">Previous</A>
|
|
<A HREF="VariablesandClassStructureUnionMembers.html">Next</A>
|
|
<HR NOSHADE>
|
|
<H3><A NAME="5_2_1">Functions and Methods</A></H3>
|
|
<P>All implementations of functions and methods must begin with a
|
|
comment header describing what the function does, the possible input
|
|
limits (if any), and the possible output values (if any), and any
|
|
special information needed, as follows:</P>
|
|
<PRE>
|
|
/*
|
|
* 'do_this()' - Compute y = this(x).
|
|
*
|
|
* Notes: none.
|
|
*/
|
|
|
|
float /* O - Inverse power value, 0.0 <= y <= 1.1 */
|
|
do_this(float x) /* I - Power value (0.0 <= x <= 1.1) */
|
|
{
|
|
...
|
|
return (y);
|
|
}
|
|
</PRE>
|
|
<P>Return/output values are indicated using an "O" prefix, input values
|
|
are indicated using the "I" prefix, and values that are both input and
|
|
output use the "IO" prefix for the corresponding in-line comment.</P>
|
|
<HR NOSHADE>
|
|
<A HREF="toc.html">Contents</A>
|
|
<A HREF="CodeDocumentationConventions.html">Previous</A>
|
|
<A HREF="VariablesandClassStructureUnionMembers.html">Next</A>
|
|
</BODY>
|
|
</HTML>
|