Skip to content
Snippets Groups Projects
Commit a912f8e6 authored by Peter Albrecht's avatar Peter Albrecht
Browse files

Added documentation for memory abstraction

parent 74e66837
No related branches found
No related tags found
1 merge request!420Add documentation to skill memory gui
...@@ -16,6 +16,15 @@ namespace armarx::skills::gui ...@@ -16,6 +16,15 @@ namespace armarx::skills::gui
using SkillMap = using SkillMap =
std::map<skills::ProviderID, std::map<skills::SkillID, skills::SkillDescription>>; std::map<skills::ProviderID, std::map<skills::SkillID, skills::SkillDescription>>;
/**
* @brief The SkillManagerWrapper class is an abstraction of the `SkillManagerInterfacePrx`.
* All widgets in the skill memory gui should interact with the memory only through a shared pointer
* to an instance of this class. For this purpose, a `MemoryCommunicatorBase` is available.\n
* This wrapper handles conversions from- and to Ice types by itself.
*
* @see MemoryCommunicatorBase
* @see SkillManagerInterface
*/
class SkillManagerWrapper : public QObject class SkillManagerWrapper : public QObject
{ {
Q_OBJECT Q_OBJECT
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment