Import Geant4 11.4.0.beta source tree

source/geometry/navigation/include/G4VExternalNavigation.hh

@@ -30,10 +30,10 @@
 // Pure virtual class to be specialised by the user for tracking with
 // an external navigation
 
-// Authors: V.Vlachoudis, G.Cosmo - CERN, 2019
+// Authors: V.Vlachoudis, G.Cosmo (CERN), 2019
 // --------------------------------------------------------------------
 #ifndef G4VEXTERNALNAVIGATION_HH
-#define G4VEXTERNALNAVIGATION_HH
+#define G4VEXTERNALNAVIGATION_HH 1
 
 #include "G4LogicalVolume.hh"
 #include "G4NavigationHistory.hh"
@@ -42,31 +42,51 @@
 #include "G4VPhysicalVolume.hh"
 #include "G4VSolid.hh"
 
+/**
+ * @brief G4VExternalNavigation is a pure virtual class to be specialised
+ * by the user for tracking with an external navigation.
+ */
+
 class G4VExternalNavigation : public G4VNavigation
 {
-  public:  // with description
+  public:
 
+    /**
+     * Constructor and Destructor.
+     */
     G4VExternalNavigation();
-      // Constructor
-   
     ~G4VExternalNavigation() override;
-      // Destructor
 
+    /**
+     * Cloning method, pure virtual.
+     */
     virtual G4VExternalNavigation* Clone() = 0;
 
     // Optional methods - may be necessary under particular circumstances
 
+    /**
+     * Special 'Inside' call that includes direction of next motion.
+     * Provided for potential optimisations.
+     *  @param[in] solid Solid to be considered.
+     *  @param[in] position Point to be checked.
+     *  @param[in] direction Not used.
+     *  @returns Whether the point is inside the solid or not.
+     */
     virtual EInside Inside( const G4VSolid*      solid,
                             const G4ThreeVector& position,
                             const G4ThreeVector& direction );
-     // Special 'Inside' call that includes direction of next motion
-     //   provided for potential optimisations.
 
-    void RelocateWithinVolume( G4VPhysicalVolume*  motherPhysical,
-                               const G4ThreeVector& localPoint ) override;
-     //   Update any relevant internal state to take account that
-     //      - the location has been moved to 'localPoint'
-     //      - it remains in the current (mother) physical volume 'motherPhysical'
+    /**
+     * Updates any relevant internal state to take account that the location
+     * has been moved to 'localPoint' and that it remains in the current
+     * (mother) physical volume 'motherPhysical'.
+     *  @note Default action is do-nothing; only implemented by the concrete
+     *        navigator class.
+     *  @param[in] motherPhysical Volume to be considered.
+     *  @param[in] localPoint Point to be checked.
+     */
+     void RelocateWithinVolume( G4VPhysicalVolume* motherPhysical,
+                                const G4ThreeVector& localPoint ) override;
 };
 
 #endif