Opened 6 years ago

Closed 5 years ago

#12322 closed Bugs (fixed)

X3 Documentation missing (or very hard to find)

Reported by: Ruben Van Boxem <vanboxem.ruben@…> Owned by: Joel de Guzman
Milestone: To Be Determined Component: spirit
Version: Boost 1.61.0 Severity: Problem
Keywords: Cc:

Description

Since Boost.Spirit.X3 has been released and included in the main Boost distribution, the only relevant documentation I have been able to find is the one for the cppnow conference here: http://ciere.com/cppnow15/x3_docs/

Suffice to say that is a terribly fragile location (i.e. not boost.org) and I doubt that nothing has changed in the code since it was put online.

The main Boost documentation should include the X3 parts, and it should match the current code.

Change History (3)

comment:1 by cppljevans@…, 6 years ago

+1.

In particular, there's this:

http://www.boost.org/doc/libs/1_61_0/libs/spirit/repository/doc/html/spirit_repository/qi_components/nonterminal/subrule.html

which says:

the implementation of rules is based on a virtual function call

which, AFAICT, is not true for x3 since, looking at:

spirit/home/x3/nonterminal/rule.hpp

and reading:

http://ciere.com/cppnow15/x3_docs/spirit/quick_reference/non_terminals.html

the implementation is based on a pair of classes, Rule and Rule_def, *and* the BOOST_SPIRIT_DEFINE macro to connect the two.

The quick_reference should make this clear that the virtual function implementation remark does not apply to x3.

Last edited 6 years ago by cppljevans (previous) (diff)

comment:2 by Nikita Kniazev <nok.raven@…>, 5 years ago

comment:3 by Joel de Guzman, 5 years ago

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.