Qt-interest Archive, December 2006
Formatting Errors in Documentation doc.trolltech.com/4.2/ - e.g. setModal. / Put extra lines at end of pages
Message 1 in thread
Hallo!
There are many(?) displaying errors in the Trolls docu. Makes me very
confusing. Please fix this.
For Example:
Go to:
* http://doc.trolltech.com/4.2/qdialog.html
Then scroll down to Section:
* Public Functions
Then click on the link for the setModal function:
* void setModal ( bool modal )
It will will take you to
modal : bool
There is a formating error (See <<=== ERROR HERE!):
-----------
Access functions:
* bool isModal () const
* void setModal ( bool modal ) <<=== ERROR HERE!
See also QWidget::windowModality, show(), and exec().
-------------------
This "* void setModal ( bool modal )" should not be in the context of
"Property Documentation", "modal : bool". Instead, its a separate
function section.
Sure, this is a access function to modal bool, but this modal bool is
not a function, as you click on "void *setModal* ( bool modal )", not on
bool modal.
Tip: Also add meny extra newlines at the end of every page. When the
user click on a link and it should be displayed always on top of the
brower view. Example: setResult. void QDialog::setResult ( int i ). Then
will be displayed on top of the broswer view.
--
[ signature omitted ]
Message 2 in thread
On 13.12.06 00:20:44, Michael Mustun wrote:
> There are many(?) displaying errors in the Trolls docu. Makes me very
> confusing. Please fix this.
No, what you describe is just the way the Qt documentation works for
properties. Thats the way all properties are documented, because the
access functions don't need further documentation, their implementation
is mostly straight-forward, setFoo will set the member variable to the
new value and getFoo or isFoo will retrieve that value.
Also this is the wrong place to demand documentation fixes from TT, they
have an official bug report channel.
> Tip: Also add meny extra newlines at the end of every page. When the user click
> on a link and it should be displayed always on top of the brower view. Example:
> setResult. void QDialog::setResult ( int i ). Then will be displayed on top of
> the broswer view.
Hmm, how about you resize your browser window so the paragraph about the
last function moves to the top of your browser ;)
Seriously, my browser window here has about 2/3 of the screen height and
I see exactly 3 methods when scrolling to the end of the page, its not
really that hard to find the bold-larger-font headline for setResult.
Andreas
--
[ signature omitted ]
