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

Support documentation hints in QML LSP (Signature Help Request)

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: P2: Important P2: Important
    • 6.11
    • None
    • QML: Tooling
    • None

      Signature help request protocol documentation:

      https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_signatureHelp

      Why do we need it:

      Outside of Creator, there is no integrated way to get to our documentation. Even inside Creator, you currently have to manually press F1 or open the context help. By using the LSP, we could also show the help automatically as an inlay (e.g. for autocompleted function calls)

        1. image-2023-12-13-10-14-28-485.png
          382 kB
          Sami Shalayel
        2. QtC hovering.mov
          19.33 MB
          Sami Shalayel
        1.
        		 Extract documentation for Qml types Sub-task Closed Semih Yavuz
        2.
        		 Extract documentation for Qml properties Sub-task Closed Semih Yavuz
        3.
        		 Extract documentation for methods and signals Sub-task Closed Semih Yavuz
        4.
        		 Extract documentation for Qml modules Sub-task Reported Qt Qml Team User
        5.
        		 Documentation from custom qml components Sub-task Reported Qt Qml Team User
        6.
        		 Documentation for ECMAScript elements Sub-task Reported Qt Qml Team User
        7.
        		 Use html for formatted documentation Sub-task Reported Qt Qml Team User
        8.
        		 Get documentation from user's qt-version Sub-task Closed Semih Yavuz
        9.
        		 Add HelpEngine API dependency to qmlls Sub-task Closed Semih Yavuz
        10.
        		 Investigate if registering documentation should take place lazily Sub-task Reported Semih Yavuz
        11.
        		 Format how help looks on the IDE Technical task Reported Semih Yavuz
        12.
        		 Investigate the multi-build scenarios for the documentation paths Technical task Reported Semih Yavuz
        13.
        		 Add doc page to explain documentation hints Technical task Closed Semih Yavuz
        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            semih.yavuz Semih Yavuz
            fabiankosmale Fabian Kosmale
            Votes:
            1 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: