<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>SimpleDoc -- simpler documentation for functions and methods</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_doc_lp__String_rp.html">next</a> | previous | <a href="_doc_lp__String_rp.html">forward</a> | backward | up | top | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>SimpleDoc -- simpler documentation for functions and methods</h1>
<div class="single"><h2>Description</h2>
<div><em>SimpleDoc</em> contains a function to simplify writing documentation for functions </div>
</div>
<div class="single"><h2>Authors</h2>
<ul><li><div class="single"><a href="http://www.math.uiuc.edu/~grayson/">Dan Grayson</a><span> <<a href="mailto:dan@math.uiuc.edu">dan@math.uiuc.edu</a>></span></div>
</li>
<li><div class="single"><a href="http://www.math.cornell.edu/~mike/">Mike Stillman</a><span> <<a href="mailto:mike@math.cornell.edu">mike@math.cornell.edu</a>></span></div>
</li>
</ul>
</div>
<div class="single"><h2>Version</h2>
This documentation describes version <b>1.0</b> of SimpleDoc.</div>
<div class="single"><h2>Source code</h2>
The source code from which this documentation is derived is in the file <a href="../../../../Macaulay2/SimpleDoc.m2">SimpleDoc.m2</a>. The auxiliary files accompanying it are in the directory <a href="../../../../Macaulay2/SimpleDoc/">SimpleDoc/</a>.</div>
<div class="single"><h2>Exports</h2>
<ul><li><div class="single">Functions<ul><li><span>doc, see <span><a href="_doc_lp__String_rp.html" title="a simple documentation function">doc(String)</a> -- a simple documentation function</span></span></li>
<li><span><a href="_package__Template.html" title="a template for a package">packageTemplate</a> -- a template for a package</span></li>
<li><span><a href="_simple__Doc__Frob.html" title="an example of a function to document">simpleDocFrob</a> -- an example of a function to document</span></li>
</ul>
</div>
</li>
<li><div class="single">Other things<ul><li><span><a href="_doc__Example.html" title="an example documentation node">docExample</a> -- an example documentation node</span></li>
<li><span><a href="_doc__Template.html" title="a template for a documentation node">docTemplate</a> -- a template for a documentation node</span></li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</body>
</html>
