Details
-
Task
-
Resolution: Unresolved
-
P2: Important
-
None
-
None
-
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.