Subject: [boost] [locale] Review: Reference documentation
From: Gevorg Voskanyan (v_gevorg_at_[hidden])
Date: 2011-04-22 11:09:07
s/like and sentence boundaries/line and sentence boundaries/
s/Find a positions/Find positions/
s/like break is required/line break is required/
s/possible followed by/possibly followed by/
"Either first or second sentence break type;." redundant ;
"word_any Any word including numbers, 0 is special flag, equivalent to 15."
What has 0 to do with word_any that it's being mentioned here? Isn't 15 the
value for word_none?
s/Maximal used mask/All types of words mask/ maybe?
s/Class the holds/Class that holds/
"When the object is created in creates index" s/in/it/ ?
"it is used mostly together ..." capitalize the first letter
s/vise versa/vice versa/ many occurrences
"you can set the mask value sentence_term" sentence_term should be a link. In
general the whole documentation should be scanned to add links where
"would not be compatible with old ones" add a period
s/white spaces punctuation/white spaces, punctuation/
s/Opposite of ===/Negation of ==/
"Return the mark that token iterator points at." Shouldn't be break iterator?
"This module that introduces collation related classes" Rephrasing needed
s/a base class that included/a base class that includes/
What about providing synonyms for collation levels like base_letters = primary,
letters_accents = secondary, etc.
s/two strings in rage/two strings in range/ Strings in rage can be harmful :D
It isn't specified what values compare functions return. E.g. is it < 0, 0, > 0
or -1, 0, 1. Needs to be explained what kind of value is returned in which case.
s/various function/various functions/
s/It does not takes/It does not take/ many occurrences
s/a enum/an enum/
cout << "Year:" t / perood::year <<" Full Date:"<< as::date_time << t;
cout << "Year:" << t / period::year <<" Full Date:"<< as::date_time << t;
Why are the operations not commutative?
s/should be in range [0,size)/should be in range [0,size())/
s/Get grates possible/Get greatest possible/
s/opject/object/ many occurrences
"Check if the current time is in daylight saving time" Current time or the time
represented by *this? In all other places, references to "current time" need to
s/ingnores/ignores/ many occurrences
s/substract/subtract/ many occurrences
"hour_12 12 clock hour [0..11]" AFAIU the range of hours in AM/PM notation
is [1..12], no?
s/First day if week/First day of week/
s/convers period_type/convert period_type/
"namespace that holds function for operating global time zone identifier" Needs
rephrasing, perhaps "namespace that holds functions for operating with global
I don't think BOOST_LOCALE_DECL needs to be in documentation.
s/curl brackets/curly braces/
"sci or `scientific` -- display in scientific format" why is scientific in
backticks and sci not?
"per or percent -- format percent value." What happens when a value out of range
[0..1] is passed in?
"locale -- with parameter -- switch locale for current operation. This command
generates locale with formatting facets giving more fine grained control of
formatting. For example: " Where is the example?
What are the requirements for Formattible?
s/Definiton/Definition/ 2 occurrences
s/It use locale and of \a out stream/It uses locale of \a out stream/
s/is treaded as/is treated as/ many occurrences
s/independed/independent/ multiple occurrences
"Generate codepage conversion facets" Isn't "encoding" more appropriate?
s/the codecvt faced/the codecvt facet/
s/it know/it knows/
s/can can/can/ two occurrences
s/Locale id (for work with std::locale/Locale id (needed to work with
s/if it deals with/if dealing with/
s/transfered/transferred/ two occurrences
s/Is underlying encoding is UTF-8/True if the underlying encoding is UTF-8/
"Default constructor" Not exactly, can be called with a size_t argument as well
"Message class can be explicitly converter to string class" converted
\ a --> \a for doxygen, 3 occurrences
operator<< not mentioned but should be as it is part of the message class
A link to group__message.html would be helpful here
s/this structure not useful/this structure is not useful/
s/for narror/For narrow/
Inconsistent documentation for data members here: some are documented in Member
Data Documentation, the other in the introduction.
"Locale category, is set by default LC_MESSAGES, but ma." Incomplete?
Sometimes qualified ids make it harder to read. For example in
group__boundary.html the boost::locale::boundary:: qualifiers make it really
hard for me to read the important part here - the individual names.
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk