[all-commits] [llvm/llvm-project] 481155: [lldb] Document the SBDebugger public interface (#...
Jonas Devlieghere via All-commits
all-commits at lists.llvm.org
Fri Jul 11 15:43:02 PDT 2025
Branch: refs/heads/main
Home: https://github.com/llvm/llvm-project
Commit: 48115529e1660d6762f538626cff271a9574257d
https://github.com/llvm/llvm-project/commit/48115529e1660d6762f538626cff271a9574257d
Author: Jonas Devlieghere <jonas at devlieghere.com>
Date: 2025-07-11 (Fri, 11 Jul 2025)
Changed paths:
M lldb/include/lldb/API/SBDebugger.h
Log Message:
-----------
[lldb] Document the SBDebugger public interface (#147621)
Despite our best efforts, improved documentation of the public API
remains a common request amongst its users. We have the Docstrings files
in the bindings directory, but coverage and quality varies greatly by
class.
I've noticed that we a bunch of Doxygen comments throughout LLDB, but
relatively few in the SB API, which might be explained by the
aforementioned Docstrings files. With #147617, we can leverage the
Doxygen documentation to automatically generate Pydoc documentation for
the Python bindings using SWIG.
Going forward, I'd like to invest in the Doxygen documentation for the
public API. This PR is a first step in that direction. The Doxygen
comments will benefit both C++ and Python clients. Additionally, the
compiler (through the -Wdocumentation flag) can help catch quality and
correctness issues.
To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications
More information about the All-commits
mailing list