[Bug libstdc++/51539] New: multiplies ::operator () undocumented

[Bug libstdc++/51539] New: multiplies ::operator () undocumented

[giecrilj at stegny dot 2a.pl]

http://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

             Bug #: 51539
           Summary: multiplies ::operator () undocumented
    Classification: Unclassified
           Product: gcc
           Version: 4.5.1
               URL: http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen
                    /a00799.html
            Status: UNCONFIRMED
          Severity: trivial
          Priority: P3
         Component: libstdc++
        AssignedTo: unassigned@gcc.gnu.org
        ReportedBy: giecrilj@stegny.2a.pl
              Host: i586-suse-linux
            Target: i586-suse-linux
             Build: i586-suse-linux


Returns the product of its operands, 
that is the result of operator * applied to them.

[Bug libstdc++/51539] multiplies ::operator () undocumented

[redi at gcc dot gnu.org]

http://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |documentation
             Status|UNCONFIRMED                 |ASSIGNED
   Last reconfirmed|                            |2011-12-13
         AssignedTo|unassigned at gcc dot       |redi at gcc dot gnu.org
                   |gnu.org                     |
     Ever Confirmed|0                           |1

[Bug libstdc++/51539] multiplies ::operator () undocumented

[redi at gcc dot gnu.org]

http://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

--- Comment #1 from Jonathan Wakely <redi at gcc dot gnu.org> 2011-12-13 23:12:47 UTC ---
It returns x*y, which may or may not be the product, the binary operator* could
be overloaded for Tp with a completely different meaning.

Actually I'm wondering if it's worth adding anything here.  What else is
multiplies going to do, except multiply?  There's already a link to a page
saying all the arithmetic operations have corresponding functors, it should be
self-explanatory.

[Bug libstdc++/51539] multiplies ::operator () undocumented

[giecrilj at stegny dot 2a.pl]

http://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

--- Comment #2 from Christopher Yeleighton <giecrilj at stegny dot 2a.pl> 2011-12-13 23:30:49 UTC ---
(In reply to comment #1)
> It returns x*y, which may or may not be the product, the binary operator* could
> be overloaded for Tp with a completely different meaning.

The result of operator * is a product.  Of course, the kind of product depends
on the operator used.

> 
> Actually I'm wondering if it's worth adding anything here.  What else is
> multiplies going to do, except multiply?  There's already a link to a page
> saying all the arithmetic operations have corresponding functors, it should be
> self-explanatory.

But then the meaning of the types defined by the class is also self-explanatory
and documented elsewhere, yet they are documented.

You choose: either you add one sentence to the documentation or you use so many
sentences to explain why the sentence need not be added.  As you like it.

[Bug libstdc++/51539] multiplies ::operator () undocumented

[redi at gcc dot gnu.org]

http://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |UNCONFIRMED
         AssignedTo|redi at gcc dot gnu.org     |unassigned at gcc dot
                   |                            |gnu.org
     Ever Confirmed|1                           |0

--- Comment #3 from Jonathan Wakely <redi at gcc dot gnu.org> 2011-12-13 23:35:24 UTC ---
(In reply to comment #2)
> But then the meaning of the types defined by the class is also self-explanatory
> and documented elsewhere, yet they are documented.

They're documented in the binary_function base class and doxygen copies that to
all derived classes.

> You choose: either you add one sentence to the documentation or you use so many
> sentences to explain why the sentence need not be added.  As you like it.

One sentence? Why only add it to multiplies, not the other arithmetic
operations?

Actually, I choose to do nothing since I don't like being told what to do, I
have more important fixes to make.

[Bug libstdc++/51539] multiplies ::operator () undocumented

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |WONTFIX
             Status|UNCONFIRMED                 |RESOLVED

--- Comment #4 from Jonathan Wakely <redi at gcc dot gnu.org> ---
The class has a doxygen comment. I see no benefit to adding a single sentence
about the operator() to one of the classes and not the other ones in the group.

Closing because nobody is motivated to do anything about this. If you want
improvements then make them yourself. I started doing it twenty years ago but
now I'm doing more important changes to the library.

[Bug libstdc++/51539] multiplies ::operator () undocumented

[giecrilj at stegny dot 2a.pl]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=51539

--- Comment #5 from Christopher Yeleighton <giecrilj at stegny dot 2a.pl> ---
Created attachment 51106
  --> https://gcc.gnu.org/bugzilla/attachment.cgi?id=51106&action=edit
Add Doxygen documentation to items in stl_function.h