Uploaded image for project: 'Qt Creator'
  1. Qt Creator
  2. QTCREATORBUG-22092

Add a way to view the documentation of the currently open project

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Reported
    • Priority: Not Evaluated
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Technical Risk:
      Normal

      Description

      Given you are a new developer and start to work on a bigger project e.g. an automotive UI, it would be very helpful to be able to see the documentation of this project while trying it out or changing files.

      QtCreator supports showing the content from QtHelp files, but this doesn't help if you open the project for the first time, as you first need to build the documentation using a command like 'make docs' and then tell QtCreator to open this qhp file.
      Once the project documentation is updated, the docs need to be build again and QtCreator need to be manually updated to load the qhp files again.

      What would be needed is that instead QtCreator is able to parse the qdoc/doxygen comments on the fly and generate docs for this project.
      QtCreator could identify what kind of documentation it is (e.g. Doxygen vs qdoc) and provide a default configuration on what docs to build and how, but it should also be possible to configure QtCreator to use a specific configuration file. E.g. by defining a specific variable QTC_DOC_CONFIGURATION=doc/mydoc.qdocconf

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            • Assignee:
              jkobus Jarek Kobus
              Reporter:
              gagi Dominik Holland
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:

                Gerrit Reviews

                There are no open Gerrit changes