mxml/www/docfiles/CodeDocumentationConventions.html
Michael R Sweet 6a062afd64 Documentation.
Tweek look-n-feel.

Fix comment editing.

Use format_text() for comments, too.
2004-05-19 16:34:55 +00:00

41 lines
1.5 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="TheBasics1.html">
<LINK REL="Next" HREF="FunctionsandMethods.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="TheBasics1.html">Previous</A>
<A HREF="FunctionsandMethods.html">Next</A>
<HR NOSHADE>
<H2><A NAME="5_2">Code Documentation Conventions</A></H2>
<P>As noted previously, source code must be commented properly for <TT>
mxmldoc</TT> to generate correct documentation for the code. Single line
comments can use the C++ <TT>//</TT> comment sequence, however all
multi-line comments must use the C <TT>/* ... */</TT> comment sequence.</P>
<HR NOSHADE>
<A HREF="toc.html">Contents</A>
<A HREF="TheBasics1.html">Previous</A>
<A HREF="FunctionsandMethods.html">Next</A>
</BODY>
</HTML>