next
| previous |
forward
| backward | up | top |
index
|
toc
|
directory
|
Macaulay 2 web site
SimpleDoc -- simpler documentation for functions and methods
Description
SimpleDoc
contains a function to simplify writing documentation for functions
Authors
Dan Grayson
<
dan@math.uiuc.edu
>
Mike Stillman
<
math@math.cornell.edu
>
Version
This documentation describes version 1.0 of SimpleDoc.
Source code
The source code is in the file
SimpleDoc.m2
.
Exports
Functions
doc, see
doc(String)
-- a simple documentation function
packageTemplate
-- a template for a package
simpleDocFrob
-- an example of a function to document
Other things
docExample
-- an example documentation node
docTemplate
-- a template for a documentation node