Uploaded image for project: 'Qt Project Website'
  1. Qt Project Website
  2. QTWEBSITE-348

New documentation format (as of 4.8) usability issues

    XMLWordPrintable

    Details

      Description

      There are usability problems with the new documentation website.

      I'm taking QPlainTextWidget to illustrate them.
      See: http://developer.qt.nokia.com/doc/qt-4.8/qplaintextedit.html

      First problem: there are missing public functions

      "setLineWrapMode ( LineWrapMode mode )" is a public function, yet it is not listed in the "Public Functions" section. It is listed elsewhere. It should be in the "Public Functions" section.

      Second problem: enum function arguments are not linked to enum definitions.

      When I look at the documentation for "setLineWrapMode ( LineWrapMode mode )", I can't click on enum "LineWrapMode". I should be able to click on the enum argument and be directed to it's definition.

        Attachments

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

          Activity

            People

            Assignee:
            mariusg mariusg (Inactive)
            Reporter:
            fbolduc Francis Bolduc
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Gerrit Reviews

                There are no open Gerrit changes