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

some links to enums on the Qt Namespace page don't work, and the rest could be more specific

    XMLWordPrintable

Details

    • cf5470e1700e0ca1f5bc828961f19e722fa422fe (qtbase)

    Description

      Let's take the links to WindowFlags in qwidget.cpp for example: here is one doc comment snippet

          Usually, windows have a frame and a title bar, although it is also possible
          to create windows without such decoration using suitable
          \l{Qt::WindowFlags}{window flags}). In Qt, QMainWindow and the various
      

      and that turns into a link to qt.html#WindowFlags-typedef which doesn't exist, so you end up at the top of the page. The anchors that do exist in that neighborhood are <a name="WindowType-enum"> and <a name="window-flag"> so maybe the link should be to one of those or maybe there is a missing anchor? Not sure.

      Qt::FramelessWindowHint turns into a link automatically (without \l) but goes to the top of the section qt.html#WindowType-enum and then you have to scroll down. So maybe it would be nice to have an anchor for each enum value, but that would be a lot of them.

      If you are at the top of qwidget.html and click on any property whose type is something from the Qt namespace, you get the documentation for that property and can then click on the type to go to the namespace page. Some of the links jump down to the correct enum and some don't. layoutDirection is one that works, but the docs for setLayoutDirection don't have any explicit links so I guess qdoc makes the link itself, successfully. But the one for inputMethodHints just goes to the top of the page.

      Attachments

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

        Activity

          People

            treinio Topi Reiniƶ
            srutledg Shawn Rutledge
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes