Changeset 11099 for code/trunk/src/modules/objects

Timestamp:

Jan 27, 2016, 6:50:51 PM (9 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/modules/objects

Files:

• Script.cc (modified) (1 diff)
• Turret.h (modified) (1 diff)
• controllers/TurretController.h (modified) (1 diff)
• triggers/DistanceTrigger.cc (modified) (1 diff)
• triggers/DistanceTriggerBeacon.cc (modified) (1 diff)
• triggers/EventTrigger.cc (modified) (1 diff)
• triggers/MultiTrigger.cc (modified) (1 diff)
• triggers/MultiTriggerContainer.cc (modified) (2 diffs)
• triggers/Trigger.cc (modified) (1 diff)

code/trunk/src/modules/objects/Script.cc

@@ -58 +58 @@
     @brief
         Constructor. Registers and initializes the object.
-    @param creator
-        The creator of this object.
     */
     Script::Script(Context* context) : BaseObject(context)

code/trunk/src/modules/objects/Turret.h

@@ -28 +28 @@
 
 /**
+    @file Turret.h
     @brief Definition of the Turret class.
     @ingroup Objects

code/trunk/src/modules/objects/controllers/TurretController.h

@@ -26 +26 @@
  *
  */
-
-/**
-    @brief Definition for the controller for turrets.
-*/
 
 #ifndef _TurretController_H__

code/trunk/src/modules/objects/triggers/DistanceTrigger.cc

@@ -54 +54 @@
     @brief
         Constructor. Registers and initializes the object.
-    @param creator
-        The creator of this trigger.
     */
     DistanceTrigger::DistanceTrigger(Context* context) : Trigger(context)

code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc

@@ -45 +45 @@
     @brief
         Constructor. Registers the object.
-    @param creator
-        The creator of this object.
     */
     DistanceTriggerBeacon::DistanceTriggerBeacon(Context* context) : StaticEntity(context)

code/trunk/src/modules/objects/triggers/EventTrigger.cc

@@ -45 +45 @@
     @brief
         Constructor. Registers and initializes the object.
-    @param creator
-        The creator of the EventTrigger.
     */
     EventTrigger::EventTrigger(Context* context) : Trigger(context)

code/trunk/src/modules/objects/triggers/MultiTrigger.cc

@@ -48 +48 @@
     @brief
         Constructor. Registers the objects and initializes default values.
-    @param creator
-        The creator.
     */
     MultiTrigger::MultiTrigger(Context* context) : TriggerBase(context)

code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc

@@ -47 +47 @@
     @brief
         Default constructor. Registers the object and creates an empty container.
-    @param creator
-        The creator.
     */
     MultiTriggerContainer::MultiTriggerContainer(Context* context) : BaseObject(context), originator_(nullptr), data_(nullptr)
@@ -58 +56 @@
     @brief
         Constructor. Registers the object and sets the input values.
-    @param creator
-        The creator.
+    @param context
+        The context.
     @param originator
         A pointer to the originator of the Event, i.e. the MultiTrigger that fired the Event. (or is about to fire)

code/trunk/src/modules/objects/triggers/Trigger.cc

@@ -51 +51 @@
     @brief
         Constructor. Registers and initializes the object.
-    @param creator
-        The creator of the Trigger.
     */
     Trigger::Trigger(Context* context) : TriggerBase(context)