Changeset 8466 for code/branches/portals2

Timestamp:

May 12, 2011, 4:15:36 PM (14 years ago)

Author:

anbueche

Message:

comments added

Location:

code/branches/portals2

Files:

• doc/api/Groups.dox (modified) (1 diff)
• src/modules/portals/PortalEndPoint.cc (modified) (1 diff)
• src/modules/portals/PortalEndPoint.h (modified) (2 diffs)
• src/modules/portals/PortalLink.h (modified) (2 diffs)

code/branches/portals2/doc/api/Groups.dox

@@ -153 +153 @@
 
 /**
+    @defgroup Portals Portals
+    @ingroup Modules
+*/
+
+/**
     @defgroup Questsystem Questsystem
     @ingroup Modules

code/branches/portals2/src/modules/portals/PortalEndPoint.cc

@@ -32 +32 @@
         XMLPortParam(PortalEndPoint, "id", setID, getID, xmlelement, mode);
         XMLPortParam(PortalEndPoint, "design", setTemplate, getTemplate, xmlelement, mode);
-        XMLPortParamExtern(PortalEndPoint, DistanceMultiTrigger, this->trigger_, "distance", setDistance, getDistance, xmlelement, mode);
+        XMLPortParamExtern(PortalEndPoint, DistanceMultiTrigger, this->trigger_, "distance", setDistance, getDistance, xmlelement, mode).defaultValues("50");
         XMLPortParamLoadOnly(PortalEndPoint, "target", setTarget, xmlelement, mode).defaultValues("Pawn");
         

code/branches/portals2/src/modules/portals/PortalEndPoint.h

@@ +1 @@
+/**
+ *  @file PortalEndPoint.h
+ *  @brief Declaration of the PortalEndPoint class.
+ *  @ingroup Portals
+ */
+
 #ifndef _PortalEndPoint_H__
 #define _PortalEndPoint_H__
@@ -15 +21 @@
 namespace orxonox
 {
+    /**
+     @brief
+     A PortalEndPoint serves as portal entrance and/or exit.
+     
+     @ingroup Portals
+     */
+    
     class _PortalsExport PortalEndPoint : public StaticEntity
     {

code/branches/portals2/src/modules/portals/PortalLink.h

@@ +1 @@
+/**
+    @file PortalLink.h
+    @brief Declaration of the PortalLink class
+    @ingroup Portals
+ */
+
 #ifndef _PortalLink_H__
 #define _PortalLink_H__
@@ -12 +18 @@
 namespace orxonox
 {
+    /**
+        @brief
+            A PortalLink represents the connection between two @ref orxonox::PortalEndPoint "PortalEndPoints"
+        @ingroup Portals
+     */
     class _PortalsExport PortalLink : public BaseObject
     {