Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-138535

As a reader of the Qt documentation, I'd like to have std:: types linked to cppreference.com

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc, Documentation
    • None

    Description

      Qt is using more and more std types in it's API. I would love to have these linked to their respective cppreference.com docs, like Qt classes itself are linked.

      There's a Doxygen tag file published by cppreference.com (https://de.cppreference.com/w/Cppreference%253AArchives.html#Doxygen_tag_file), though they're outdated (but there's a talk note on how to make them from the source: https://de.cppreference.com/w/Cppreference_talk%253AArchives.html#How_to_update_the_Doxygen_tag_files.3F).

      Or maybe the QCH files would help? https://de.cppreference.com/w/Cppreference%253AArchives.html#Qt_help_book

      There was some discussion about shipping these docs with Qt/QtC: QTBUG-74789, QTBUG-79591. This is not about that. This is about linking to the (online or offline) docs so that e.g. "std::thread" automatically becomes a link (incl. in code snippets) to https://en.cppreference.com/w/cpp/thread/thread.html

      Attachments

        Issue Links

          is required for

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. QTBUG-110059 Use 'std::chrono first' approach for timer methods (like QObject::startTimer, QTimer, QDeadlineTimer etc.)

          • Not Evaluated - Not yet evaluated/prioritized
          • Open
          relates to

          Suggestion - Public suggestions QTBUG-79591 Offer to install C++-Reference from cppreference.com during install

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Suggestion - Public suggestions QTBUG-74789 Doc: Include STL documentation in docs

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-138538 Link to cppreference from all docs that use C++14 chrono literals

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • In Progress
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              mmutz Marc Mutz
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes