Opened 12 years ago

Closed 12 years ago

#5376 closed Bugs (fixed)

Incorrect description for template parameters of handles_container

Reported by: Yasutaka ATARASHI <atara-y@…> Owned by: Hartmut Kaiser
Milestone: To Be Determined Component: spirit
Version: Boost 1.46.0 Severity: Cosmetic
Keywords: Cc:

Description

http://www.boost.org/doc/libs/1_46_1/libs/spirit/doc/html/spirit/advanced/customize/handles_container.html says that the type of handles_container is as follows:

template <typename Component, typename Attribute, typename Enable>
struct handles_container
{
    typedef <unspecified> type;
};

However, in boost/spirit/home/support/handles_container.hpp, it is defined as follows:

    template <typename T, typename Attribute, typename Context
            , typename Iterator, typename Enable>
    struct handles_container : mpl::false_ {};

NOTE: Version field does not have 1.46.1, so I set it to 1.46.0.

Change History (4)

comment:1 by Joel de Guzman, 12 years ago

Owner: changed from Joel de Guzman to Hartmut Kaiser

comment:2 by Hartmut Kaiser, 12 years ago

I'm sorry, but I don't understand your problem. In the example you give handles_container<> is implemented using meta function forwarding. The base type mpl::false_ implements the embedded type type, therefore, we have no need to repeat that definition inside handles_container<>.

in reply to:  2 comment:3 by anonymous, 12 years ago

Severity: ProblemCosmetic

Replying to hkaiser:

I'm sorry, but I don't understand your problem. In the example you give handles_container<> is implemented using meta function forwarding. The base type mpl::false_ implements the embedded type type, therefore, we have no need to repeat that definition inside handles_container<>.

Just an inconsistency between documentation and implementation for template parameters. Documentation has 3 template parameters, Component, Attribute and Enable. On the other hand, implementation has 5 parameters, T, Attribute, Context, Iterator and Enable.

This is off-topic issue: Is severity 'Cosmetic' better for documentation-related thing?

comment:4 by Hartmut Kaiser, 12 years ago

Resolution: fixed
Status: newclosed

(In [70638]) Spirit: Fixed #5376: Incorrect description for template parameters of handles_container

Note: See TracTickets for help on using tickets.