doryan/BloomPatched
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidying comments

Browse Source
This commit is contained in:
Nav
2021-10-10 23:18:06 +01:00
parent 49cb5da872
commit 3318403970
2 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/TargetController/TargetController.hpp
View File

@@ -25,7 +25,7 @@ namespace Bloom
/** /**
* The TargetController possesses full control of the debugging target and the debug tool. * The TargetController possesses full control of the debugging target and the debug tool.
* *
` * The TargetController runs on a dedicated thread. Its sole purpose is to handle communication to & from the * The TargetController runs on a dedicated thread. Its sole purpose is to handle communication to & from the
* debug tool and target. * debug tool and target.
* *
* The TargetController should be oblivious to any manufacture/device specific functionality. It should * The TargetController should be oblivious to any manufacture/device specific functionality. It should

24
src/TargetController/TargetControllerConsole.hpp
View File

@@ -18,8 +18,7 @@
namespace Bloom namespace Bloom
{ {
/** /**
* The TargetControllerConsole provides an interface to the TargetController, for components within Bloom that * The TargetControllerConsole provides an interface to the TargetController.
* require access to common functionality from the TargetController.
*/ */
class TargetControllerConsole class TargetControllerConsole
{ {
@@ -31,8 +30,23 @@ namespace Bloom
this->defaultTimeout = timeout; this->defaultTimeout = timeout;
} }
/**
* Requests the current TargetController state from the TargetController. The TargetController should always
* respond to such a request, even when it's in a suspended state.
*
* To check if the TargetController is in an active state, isTargetControllerInService() can be used for
* convenience.
*
* @return
*/
TargetControllerState getTargetControllerState(); TargetControllerState getTargetControllerState();
/**
* Retrieves the TargetController state and checks if it's currently active.
*
* @return
* True if the TargetController is currently in an active state, otherwise false.
*/
bool isTargetControllerInService() noexcept; bool isTargetControllerInService() noexcept;
/** /**
@@ -151,11 +165,11 @@ namespace Bloom
* Triggers an event for the TargetController and waits for a response. * Triggers an event for the TargetController and waits for a response.
* *
* To use this method, the triggered event must define a 'TargetControllerResponseType' alias, which should * To use this method, the triggered event must define a 'TargetControllerResponseType' alias, which should
* specify the type of response expected by the TargetController. * specify the type of response expected from the TargetController.
* For an example of this, see the Events::ExtractTargetDescriptor class. * For an example of this, see the Events::ExtractTargetDescriptor class.
* *
* If the TargetController fails to respond within the given time specified by the timeout parameter, or it * If the TargetController fails to respond within the given time specified by the timeout argument, or it
* responds with an instance of Events::TargetControllerErrorOccurred, this method will throw an exception. * responds with an instance of Events::TargetControllerErrorOccurred, this function will throw an exception.
* *
* @tparam TriggerEventType * @tparam TriggerEventType
* *