Changeset 10828 for code/branches/cpp11_v2/src/libraries/core/command/Executor.h

Timestamp:

Nov 22, 2015, 5:26:10 PM (8 years ago)

Author:

landauf

Message:

updated documentation

File:

• code/branches/cpp11_v2/src/libraries/core/command/Executor.h (modified) (2 diffs)

code/branches/cpp11_v2/src/libraries/core/command/Executor.h

@@ -42 +42 @@
     orxonox::Executor is used to wrap an orxonox::Functor and to store default values for
     its parameters. Usually one uses the function createExecutor() to create a new executor.
-    This function returns an orxonox::ExecutorPtr which is a typedef of @ref orxonox::SharedPtr
-    "SharedPtr<Executor>", used to manage the pointer to the executor.
+    This function returns an orxonox::ExecutorPtr which is a typedef of "std::shared_ptr<Executor>",
+    used to manage the pointer to the executor.
 
     Executors are mostly used to execute callbacks. Because some callback functions need arguments,
@@ -74 +74 @@
     @endcode
 
-    Because executors that were created with createExecutor() are managed by an orxonox::SharedPtr,
-    they don't need to be deleted after usage.
+    Executors don't need to be deleted after usage normally because they are managed by an
+    std::shared_ptr when they were created with createExecutor().
 */