Opened 12 years ago
Closed 12 years ago
#4232 closed Bugs (fixed)
Minor documentation feedbacks
Reported by: | Guillaume Labourey | Owned by: | Joel de Guzman |
---|---|---|---|
Milestone: | Boost 1.43.0 | Component: | spirit |
Version: | Boost 1.44.0 | Severity: | Cosmetic |
Keywords: | Cc: |
Description
Hello,
On the documentation, I think there is a little "copy-paste" mistake in a Qi parser description spirit/doc/qi/concepts.qbk from line 26 to line 30:
The /Parser/ is the most fundamental concept. A Parser has a member
function, parse
, that accepts a first-last fwditer pair andreturns bool as its result. The iterators delimit the data being parsed.function parse
, that accepts a
first-last fwditer pair and
returns bool
as its result. The iterators delimit the data being parsed.
The Parser's parse
member function returns true
if the parse
succeeds, in which case the first iterator is advanced accordingly. Each
Parser can represent a specific pattern or algorithm, or it can be a
more complex parser formed as a composition of other Parsers.
It should be replaced by:
The /Parser/ is the most fundamental concept. A Parser has a member
function, parse
, that accepts a first-last fwditer pair and returns bool as its result. The iterators delimit the data being parsed.
The Parser's parse
member function returns true
if the parse
succeeds, in which case the first iterator is advanced accordingly. Each
Parser can represent a specific pattern or algorithm, or it can be a
more complex parser formed as a composition of other Parsers.
Best regards, Guillaume