[boost] program options documentation

From: Rutger ter Borg (rutger_at_[hidden])
Date: 2005-02-18 06:54:13

Hi,

I noticed that the documentation of the Boost.Program_options library has a
small inconsistency regarding the add_options method.

In the tutorial section and in the Options Descriptions Component subsection
of the Library Overview, add_options is documented in a form that is
probably meant as the correct one:

desc.add_options()
    ("compression", po::value<int>(), "set compression level");

while on the other hand, under Library Overview/Options Description
Component/Syntactic information it is written as

desc.add_options()
    ("compression", "compression level", value<string>());

, i.e., the 2nd and 3rd arguments are exemplified in a different (likely
wrong) order. 

Best regards,

Rutger