[Filter Class Name]
[ a brief (1 or 2 line) summary of what the filter does ]
Header File
[ the header file in which the filter class is declared ]
Description
[ a full explanation of what the filter does and how to use it ]
Constructors
[ the prototype for each of the filter class` constructors (including
the default value, if any, of each parameter) and
a short description of what the constructed filter does
- references to constructor paramters in the description
should be wrapped in 'var' tags
]
[FilterClass](const [FilterClass] &f)
- copy constructor
Limitations
[ a list of intentional limitations of the filter class - unintentional
limitations should appear under Known Bugs (below) ]
Known Bugs
[ a list of known but as-yet unfixed problems with the filter class ]
Author and Copyright
- written by [your/author`s name]
([authors-id@address.com])
- Copyright © 1997 [author`s name]
- licensing: [licensing type for the filter: GPL, public domain, etc.]
Author: James MacKay
Last Updated: June 5, 1997
Copyright © 1997 James MacKay