[Orxonox-commit 3786] r8466 - in code/branches/portals2: doc/api src/modules/portals

[anbueche at orxonox.net]

Author: anbueche
Date: 2011-05-12 16:15:36 +0200 (Thu, 12 May 2011)
New Revision: 8466

Modified:
   code/branches/portals2/doc/api/Groups.dox
   code/branches/portals2/src/modules/portals/PortalEndPoint.cc
   code/branches/portals2/src/modules/portals/PortalEndPoint.h
   code/branches/portals2/src/modules/portals/PortalLink.h
Log:
comments added

Modified: code/branches/portals2/doc/api/Groups.dox
===================================================================
--- code/branches/portals2/doc/api/Groups.dox	2011-05-12 14:00:07 UTC (rev 8465)
+++ code/branches/portals2/doc/api/Groups.dox	2011-05-12 14:15:36 UTC (rev 8466)
@@ -152,6 +152,11 @@
 */
 
 /**
+    @defgroup Portals Portals
+    @ingroup Modules
+*/
+
+/**
     @defgroup Questsystem Questsystem
     @ingroup Modules
 */

Modified: code/branches/portals2/src/modules/portals/PortalEndPoint.cc
===================================================================
--- code/branches/portals2/src/modules/portals/PortalEndPoint.cc	2011-05-12 14:00:07 UTC (rev 8465)
+++ code/branches/portals2/src/modules/portals/PortalEndPoint.cc	2011-05-12 14:15:36 UTC (rev 8466)
@@ -31,7 +31,7 @@
         
         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");
         
         // Add the DistanceMultiTrigger as event source.

Modified: code/branches/portals2/src/modules/portals/PortalEndPoint.h
===================================================================
--- code/branches/portals2/src/modules/portals/PortalEndPoint.h	2011-05-12 14:00:07 UTC (rev 8465)
+++ code/branches/portals2/src/modules/portals/PortalEndPoint.h	2011-05-12 14:15:36 UTC (rev 8466)
@@ -1,3 +1,9 @@
+/**
+ *  @file PortalEndPoint.h
+ *  @brief Declaration of the PortalEndPoint class.
+ *  @ingroup Portals
+ */
+
 #ifndef _PortalEndPoint_H__
 #define _PortalEndPoint_H__
 
@@ -14,6 +20,13 @@
 
 namespace orxonox
 {
+    /**
+     @brief
+     A PortalEndPoint serves as portal entrance and/or exit.
+     
+     @ingroup Portals
+     */
+    
     class _PortalsExport PortalEndPoint : public StaticEntity
     {
         public:

Modified: code/branches/portals2/src/modules/portals/PortalLink.h
===================================================================
--- code/branches/portals2/src/modules/portals/PortalLink.h	2011-05-12 14:00:07 UTC (rev 8465)
+++ code/branches/portals2/src/modules/portals/PortalLink.h	2011-05-12 14:15:36 UTC (rev 8466)
@@ -1,3 +1,9 @@
+/**
+    @file PortalLink.h
+    @brief Declaration of the PortalLink class
+    @ingroup Portals
+ */
+
 #ifndef _PortalLink_H__
 #define _PortalLink_H__
 
@@ -11,6 +17,11 @@
 
 namespace orxonox
 {
+    /**
+        @brief
+            A PortalLink represents the connection between two @ref orxonox::PortalEndPoint "PortalEndPoints"
+        @ingroup Portals
+     */
     class _PortalsExport PortalLink : public BaseObject
     {
         public: