[solved] New documentation format usability issues

fbolduc

There are usability problems with the new documentation.

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.

koahnig

welcome to devnet

Did you considerto file a bugreport on "JIRA":https://bugreports.qt.nokia.com/secure/Dashboard.jspa ?
JIRA is the official tool for bug reports and ensures that someone will take of the issue.

goetz

lineWrapMode is a property, and the setters and getters for properties are listed with those. It can be useful to have them listed in the methods list too.

fbolduc

I created an issue in JIRA:

https://bugreports.qt.nokia.com/browse/QTWEBSITE-348

mgran

Thanks fbolduc :)

daviddoria

It also seems you cannot see inherited signals. For example:
http://developer.qt.nokia.com/doc/qt-4.8/QStringListModel.html

shows no signals. Clicking "Inherits", it's parent class also has no signals. Not until you get to the next "Inherits" do you see the signals. This is quite confusing. Doxygen has a "Show all members" where you could see things like that - is there something like that in the new docs?

mgran

We're quite close to getting the traditional layout online, had hoped for today even. So in a few business hours we hope this issue will have vanished into this air.