Uploaded image for project: 'Qt Quality Assurance Infrastructure'
  1. Qt Quality Assurance Infrastructure
  2. QTQAINFRA-6587

Investigate creation of a bot to write qdoc summaries of function outputs

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Other Bots
    • None

    Description

      A hallway discussion at QtCS '24 resulted in a proposal for an AI related bot to assist with QDoc comments with describe the output/result of a function call.

      At present, documentation includes the return type, but sometimes fails to explain in useful terms what calling a function actually does to manipulate an input object or otherwise, what, exactly a function does when it is called.

      It may be possible to feed functions and existing documentation comments into an advanced LLM, requesting QDoc formatted comments (ideally with QDoc commands like \sa to reference related documentation) that describe in better detail a function's action.

      The goal here is to provide more complete and structured documentation.

      Attachments

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

        Activity

          People

            daniel.smith Daniel Smith
            daniel.smith Daniel Smith
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes