Re: Documentation Template question

From: bill_kempf (williamkempf_at_[hidden])
Date: 2002-02-11 16:11:41

--- In boost_at_y..., "David Abrahams" <david.abrahams_at_r...> wrote:
> Why the "-spec" suffix on the references to components in a header?

The standard, and thus the templates, break the sections (macros, 
values, types, classes, functions and objects) into summary and 
detailed specifications, so the -spec refers to the detail 
specification of the section.  Unfortunately, they are currently not 
being used correctly, since the template doesn't accurately portray 
both the summary and the detailed sections.  The only sections that I 
have fleshed out well enough to be correct in this regard are the 
functions and classes sections.  This is one area where the templates 
need work.

Bill Kempf