|
Boost : |
From: Jeremy Siek (jsiek_at_[hidden])
Date: 2001-08-24 16:35:29
Some comments on tokenizer.htm:
The Template Parameters table should include a column for default
parameters. Also the header font is too small, should be the same as the
other section headers.
The constructors and member functions should each have a description and
the other clauses, such as preconditions, effects, etc. Look at some of
the other boost libraries or the SGI STL docs for examples.
The table at the bottom with the header "Parameter" and "Description"
seems to be lost... what function is this table for? It looks like you
bunched together the docs for several functions... this is confusing. Each
function should be documented separately.
Cheers,
Jeremy
----------------------------------------------------------------------
Jeremy Siek http://php.indiana.edu/~jsiek/
Ph.D. Student, Indiana Univ. B'ton email: jsiek_at_[hidden]
C++ Booster (http://www.boost.org) office phone: (812) 855-9761
----------------------------------------------------------------------
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk