Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-3398

Phonon documentation is wrong (due to an assumption in qdoc)

    XMLWordPrintable

Details

    Description

      If you look at the documentation for Phonon, it directs you here:
      http://doc.trolltech.com/4.4/phonon.html

      There is a problem though. Doing #include <Phonon> does not work. The correct file to include is #include <phononnamespace.h>. Last time I checked, it was not possible to tell qdoc what file to include for a namespace or class (it assumes that the name of the namespace/class is the name of the include file).

      This cannot be solved just by changing phonon as phonon is a third party library and that brings me to the second, related problem.

      syncqt creates include/phonon/phonon but this is not a standard header for phonon. As a consequence, #include <phonon> works only when using a phonon built by Qt but not when phonon comes from the system (as is the case on my SuSE 11 box).

      Attachments

        1. 0001-Stop-creating-the-phonon-include.patch
          1.0 kB
          Lincoln Ramsay (closed Nokia identity)
        2. 0002-Allow-namespace-to-override-the-include-line.patch
          2 kB
          Lincoln Ramsay (closed Nokia identity)

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              gbk Martin Smith (Qt)
              lramsay Lincoln Ramsay (closed Nokia identity) (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes