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

Structured way for documentation begin/ends instead of markers

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • Icon: Not Evaluated Not Evaluated
    • None
    • None
    • Build tools: qdoc
    • None

      The html output of QDoc is used by QtCreator to provide help on hovering tokens. Also, QML LSP is currently implementing lsp-documentation-hints relying on qdoc's html output.

      Unfortunately, there is no a structural way to extract documentation info from html files. QtCreator extracts documentation relying on some markers that }}{{QDoc writes to denote the beginning and the end of an elements. For example,

      // qtobject.html
      <!-- $$$QtObject-brief -->
      <p>A basic QML type. <a href="#details">More...</a></p>
      <!-- @@@QtObject --> 

      To extract "Basic QML type.", we first find the start mark <!-- $$$QtObject-brief --> and do the processing until the end mark. But this wouldn't work in case there is a code snippet before using this snippet.

      // snippet
      Button {
          text: "Hit the button to get 🤑<!-- $$$QtObject-brief -->🤑"
      }?

       

      Although this could be a rare case, we still need a structural way to obtain documentations for elements from qdoc-htmls without relying on markers.

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

            docinfrastructure Documentation Infrastructure Team
            semih.yavuz Semih Yavuz
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:

                There are no open Gerrit changes