Changeset 8599 for code/branches/portals2/doc/api

Timestamp:

May 26, 2011, 3:44:07 PM (14 years ago)

Author:

anbueche

Message:

comments and license added

File:

• code/branches/portals2/doc/api/groups/Portals.dox (modified) (2 diffs)

code/branches/portals2/doc/api/groups/Portals.dox

@@ -3 +3 @@
     @ingroup Modules
 
-    This module allows you to place @ref modules::PortalEndPoint "PortalEndPoints" in space and connect pairs of them with a @ref modules::PortalLink "PortalLink" in order allow fast travelling from A to B.
+    This module allows you to place @ref orxonox::PortalEndPoint "PortalEndPoints" in space and connect pairs of them with a @ref orxonox::PortalLink "PortalLink" in order to allow fast travelling from A to B.
 
     @section FastHowTo Fast HowTo: Including portals in a level
@@ -53 +53 @@
     @subsection Templates "Templates"
     In order to make @ref orxonox::PortalEndPoint "PortalEndPoints" visible in the game there must be something visible.
-    The idea above is to define or include arbitrary Templates which make a PortalEndPoint visible and later use them by setting the design attribute of a @ref orxonox::PortalEndPoint "PortalEndPoint" to the template name
+    The idea (as shown above) is to define or include arbitrary Templates which make a PortalEndPoint visible and use them later by setting the design attribute of a @ref orxonox::PortalEndPoint "PortalEndPoint" to the template name
     @subsection Parameters "Parameters"
      - position: 3d-coordinate in space
-     - distance (default: 50): distance at which a valid entity gets pulled in by the @ref orxonox::PortalEndPoint (if the end point is an entrance)
+     - distance (default: 50): distance at which a valid entity gets pulled in (if the end point is an entrance).
      - target (default: "Pawn"): the class which is able to enter this end point (if it is an entrance)
-     - design: the name of the @ref orxonox::Template "Template" above
+     - design: the name of the @ref orxonox::Template "design template"
 */