Important: Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

Automated linking to documentation



  • Is the automated linking to Qt documentation something new?

    I just discoverd that Qt class names are automatically linked to the documentation.
    For instance here for QTextEdit
    @
    // this is stupid code
    QTextEdit text;
    @

    At least I did not notice so far.



  • Hmmm... Interesting feature. Did not notice that before either. Would it make sense to have that for the whole post, and not just for code sections?



  • [quote author="Andre" date="1324474161"]Hmmm... Interesting feature. Did not notice that before either. Would it make sense to have that for the whole post, and not just for code sections?[/quote]

    Could be a matter of performance. But you are certainly right.



  • Yeah, I was hoping that using the @<code></code>@ tags would do the same parsing as the "at" symbols, but it just changes the style of the text, it doesn't parse it. At least then you could do inline documentation links easily. Maybe that is a simple mod?



  • Great discovery, Koahnig!



  • Hey, it has been announced in Alexandra's "blog about the new docs":/blog/view/qt-4.8-docs-now-on-qt-devnet - didn't you read it carefully? :-D

    @Chris H
    there's a special syntax highlighter active when using @-tags. It's not fired up for < code> tags.



  • [quote author="Volker" date="1324506208"]Hey, it has been announced in Alexandra's "blog about the new docs":/blog/view/qt-4.8-docs-now-on-qt-devnet - didn't you read it carefully? :-D
    [/quote]

    Ooops, no. Was apparently dumped with an information overflow ;-)



  • The auto linking in the syntax highlighter is a new feature, we hope you find it useful. Got that when we switched to server side syntax highlighter a release ago.

    For the wiki, forum and comment fields we are adding a syntax that looks like this:

    [ [ Doc:QObject::objectName ] ] (without the extra spaces)

    Now that we have working doc anchors like http://developer.qt.nokia.com/doc/qt-4.8/qwidget.html#addAction we can do that.

    Note: [ [ Doc:QObject ] ] already works; [[Doc:QObject]]



  • [quote author="mariusg" date="1324566625"]
    Now that we have working doc anchors like http://developer.qt.nokia.com/doc/qt-4.8/qwidget.html#addAction we can do that.[/quote]

    I have noticed that part too. Works GREAT!!!



  • That's awesome, looking forward to it!


Log in to reply