Retropex/bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/bitcoin.git synced 2025-05-29 13:32:33 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: doxygen comment for m_args usage in tests

Browse Source 
Closes: #25055

Add doxygen comment to the m_args member in the unit test framework,
clarifying its purpose.
This commit is contained in:
willcl-ark 2024-10-13 08:59:33 +01:00
parent 48cf3da636
commit 1fe1b3ba8e
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/test/util/setup_common.h
View File

@ -75,6 +75,23 @@ struct BasicTestingSetup {
fs::path m_path_root;
fs::path m_path_lock;
bool m_has_custom_datadir{false};
/** @brief Test-specific arguments and settings.
*
* This member is intended to be the primary source of settings for code
* being tested by unit tests. It exists to make tests more self-contained
* and reduce reliance on global state.
*
* Usage guidelines:
* 1. Prefer using m_args where possible in test code.
* 2. If m_args is not accessible, use m_node.args as a fallback.
* 3. Avoid direct references to gArgs in test code.
*
* Note: Currently, m_node.args points to gArgs for backwards
* compatibility. In the future, it will point to m_args to further isolate
* test environments.
*
* @see https://github.com/bitcoin/bitcoin/issues/25055 for additional context.
*/
ArgsManager m_args;
};