[Suggestion] Link to Qt source from Qt docs



  • Hello,

    Not sure if this is the correct place to post...

    Would it be possible to include a link from the Qt docs for any particular method to the actual source code?

    This would both help me understand Qt as well provide quick guidance as to how hard it would be to sub-class any given functionality

    A participial advantage of Qt (at least for us windows users) is that it's open source. Might as well leverage that.

    For instance:
    http://doc.qt.nokia.com/4.7/qframe.html#changeEvent should have link to something like http://qt.gitorious.org/qt/qt/blobs/4.7/src/gui/widgets/qframe.cpp

    Although, actually linking to gitorious itself might be suboptimal given that:

    • The syntax highlighting is broken for multi-line comments.
    • It's page formatting forces line numbers to come along with copy-paste
    • You can't link directly to specific method blocks. (Line 540: "void QFrame::changeEvent(QEvent *ev)", in this case)

    Thank you



  • hi,

    I'm not sure, whethger it would be good to do so, as it would need new links for each new version (4.7.1, 4.7.2, ...) which have mostly only one onlinehelp.

    If this should be done, post a suggestion in "Jira":http://bugreports.qt.nokia.com/secure/Dashboard.jspa topic Qt component documentation.

    This way it reaches the people, who are working on that :-) If you create dthe issue, please post a link here. Thanks.



  • I think it is an interesting suggestion. Perhaps that could be part of the already ongoing effort to have the docs integrated in DevNet in the future (with user comments!).

    Please file a feature suggestion on "Jira":http://bugreports.qt.nokia.com/browse/QTWEBSITE.



  • Here is the issue I posted in Jira:
    http://bugreports.qt.nokia.com/browse/QTBUG-19009

    Did I do that correctly?



  • yes, looks good.
    One suggestion: if there is already a forum discussion here, also add the link to that discussion to the Jira entry. I already did this now.


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.