Merge pull request #565 from suavecode/fix-doxygen

fixes for release
suavecode · Mar 17, 2022 · 6554d2b · 6554d2b
2 parents 11f0909 + f471b8a
commit 6554d2b
Show file tree

Hide file tree

Showing 24 changed files with 66 additions and 49 deletions.
diff --git a/doc/suave_config b/doc/suave_config
@@ -38,7 +38,7 @@ PROJECT_NAME           = SUAVE
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.5.0
+PROJECT_NUMBER         = 2.5.2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/trunk/SUAVE/Components/Airfoils/Airfoil.py b/trunk/SUAVE/Components/Airfoils/Airfoil.py
@@ -17,7 +17,7 @@
 #   Airfoil
 # ------------------------------------------------------------
 
-## @ingroup Components-Wings-Airfoils
+## @ingroup Components-Airfoils
 class Airfoil(Lofted_Body.Section):
     def __defaults__(self):
         """This sets the default values of a airfoil defined in SUAVE.

diff --git a/trunk/SUAVE/Components/Airfoils/__init__.py b/trunk/SUAVE/Components/Airfoils/__init__.py
@@ -1,5 +1,6 @@
 ## @defgroup Components-Airfoils Airfoils
 # @ingroup Components
+## @defgroup Components
 #
 # __init__.py
 # 

diff --git a/trunk/SUAVE/Components/Energy/Charging/__init__.py b/trunk/SUAVE/Components/Energy/Charging/__init__.py
@@ -1,4 +1,6 @@
 ## @defgroup Components-Energy-Charging Charging   
+## @ingroup Components-Energy
+
 # __init__.py
 # 
 # Created: Nov 2019, M. Clarke

diff --git a/trunk/SUAVE/Components/Landing_Gear/__init__.py b/trunk/SUAVE/Components/Landing_Gear/__init__.py
@@ -1,4 +1,4 @@
-## @defgroup components-landing_gear Landing Gear
+## @defgroup Components-Landing_Gear Landing Gear
 # Components considered are the Main and Nose Landing Gear
 ## @ingroup Components
 

diff --git a/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py b/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py
@@ -19,7 +19,7 @@
 #  Fuselage Segments
 # ------------------------------------------------------------
 
-## @ingroup Components-Fuselages
+## @ingroup Components-Lofted_Body_Segment
 class Segment(Lofted_Body.Segment):
     def __defaults__(self):
         """This sets the defaults for fuselage segments in SUAVE.
@@ -51,7 +51,7 @@ def __defaults__(self):
         self.vsp_data.xsec_id   = ''       # OpenVSP XSec ID such as 'MWLKSGTGDD'
         self.vsp_data.shape     = ''
 
-## @ingroup Components-Wings
+## @ingroup Components-Lofted_Body_Segment
 class Segment_Container(Lofted_Body.Segment.Container):
     """ Container for wing segment
     

diff --git a/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py b/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py
@@ -1,4 +1,4 @@
-## @defgroup components-Lofted_Body_Segment
+## @defgroup components-Lofted_Body_Segment Lofted_Body_Segment
 # Components traditionally considered to be the fuselage of a vehicle.
 # These typically contain the primary payload of the vehicle.
 ## @ingroup Components

diff --git a/trunk/SUAVE/Components/Nacelles/Nacelle.py b/trunk/SUAVE/Components/Nacelles/Nacelle.py
@@ -1,4 +1,4 @@
-## @defgroup Components-Energy-Nacelles Nacelles
+## @defgroup Components-Nacelles
 # Nacelle.py
 # 
 # Created:  Jul 2021, M. Clarke  
@@ -16,7 +16,7 @@
 #  Nacalle
 # ------------------------------------------------------------
 
-## @ingroup components-nacelles
+## @ingroup Components-Nacelles
 class Nacelle(Lofted_Body):
     """ This is a nacelle for a generic aircraft.
     

diff --git a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py
@@ -57,6 +57,7 @@ def oblique_shock_relations(M0,gamma,theta,beta):
 
     return M1,Pr,Tr,Ptr
 
+## @ingroup Methods-Aerodynamics-Common-Gas_Dynamics
 def theta_beta_mach(M0,gamma,theta,n=0):
     """Computes shock angle of an oblique shock
     

diff --git a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py
@@ -1,5 +1,5 @@
 ## @defgroup Methods-Aerodynamics-Common-Gas_Dynamics Gas_Dymamics
 # Gas Dynamics methods that are directly specified by analyses.
-# @ingroup Methods-Aerodynamics-Common-Gas_Dynamics
+# @ingroup Methods-Aerodynamics
 
 from .Oblique_Shock import oblique_shock_relations, theta_beta_mach
diff --git a/trunk/SUAVE/Methods/Noise/Certification/__init__.py b/trunk/SUAVE/Methods/Noise/Certification/__init__.py
@@ -1,5 +1,5 @@
-## @defgroup Methods-Noise-Correlation Correlation 
-# @ingroup Methods-Noise-Correlation 
+## @defgroup Methods-Noise-Certification Certification
+# @ingroup Methods-Noise
 
 from .approach_noise   import approach_noise
 from .flyover_noise    import flyover_noise

diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py
@@ -1,5 +1,6 @@
-## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_One
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_One Fidelity_One
 # Rotor wake methods that are directly specified by analyses.
+# @ingroup Methods-Propulsion-Rotor_Wake
 
 from .compute_fidelity_one_inflow_velocities  import compute_fidelity_one_inflow_velocities 
 from .compute_wake_induced_velocity           import compute_wake_induced_velocity
diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py
@@ -1,4 +1,4 @@
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift
+## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One
 # compute_wake_induced_velocity.py
 # 
 # Created:  Sep 2020, M. Clarke 
@@ -11,7 +11,7 @@
 # package imports
 import numpy as np 
 
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift 
+## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One
 def compute_wake_induced_velocity(WD,VD,cpts,azi_start_idx=0,sigma=0.11,suppress_root=False):  
     """ This computes the velocity induced by the Fidelity One semi-prescribed vortex wake (PVW)
     on lifting surface control points
@@ -88,7 +88,7 @@ def compute_wake_induced_velocity(WD,VD,cpts,azi_start_idx=0,sigma=0.11,suppress
 # -------------------------------------------------------------------------------
 # vortex strength computation
 # -------------------------------------------------------------------------------
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift
+## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One
 def vortex(X,Y,Z,X1,Y1,Z1,X2,Y2,Z2,sigma, GAMMA = 1, bv=False,WD=None,use_regularization_kernal=True):
     """ This computes the velocity induced on a control point by a segment
     of a horseshoe vortex that points from point 1 to point 2 for a filament with
@@ -161,7 +161,7 @@ def row_reduction_summation(A):
 
     return sum_res
 
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift 
+## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One
 def regularization_kernel(COEF_in, sigma):
     """
     Regularization kernel used to prevent singularities

diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py
@@ -1,5 +1,6 @@
-## @defgroup Methods-Aerodynamics-Rotor_Wake-Fidelity_Zero
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero Fidelity_Zero
 # Rotor wake methods that are directly specified by analyses.
+# @ingroup Methods-Propulsion-Rotor_Wake
 
 from .compute_fidelity_zero_induced_velocity   import compute_fidelity_zero_induced_velocity 
 from .compute_wake_contraction_matrix          import compute_wake_contraction_matrix
diff --git a/...AVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py b/...AVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py
@@ -1,4 +1,4 @@
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 # compute_fidelity_zero_induced_velocity.py
 # 
 # Created:  Jun 2021, R. Erhard 
@@ -11,7 +11,7 @@
 import numpy as np 
 from scipy.interpolate import interp1d
 
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift 
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 def compute_fidelity_zero_induced_velocity(evaluation_points, props, ctrl_pts, identical_flag=False):  
     """ This computes the velocity induced by the fidelity zero wake
     on specified evaluation points.

diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py
@@ -1,4 +1,4 @@
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 # compute_wake_contraction_matrix.py
 # 
 # Created:  Sep 2020, M. Clarke 
@@ -11,7 +11,7 @@
 # package imports
 import numpy as np 
 
-## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift 
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 def compute_wake_contraction_matrix(prop,Nr,m,nts,X_pts,prop_outputs):
     """ This computes slipstream development factor for all points 
     along slipstream

diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py
@@ -1,4 +1,4 @@
-## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 # fidelity_zero_wake_convergence.py
 #
 # Created:  Feb 2022, R. Erhard
@@ -8,7 +8,7 @@
 import numpy as np
 import copy
 
-## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 def fidelity_zero_wake_convergence(wake,rotor,wake_inputs):
     """
     Wake evaluation is performed using a simplified vortex wake method for Fidelity Zero, 
@@ -119,7 +119,7 @@ def fidelity_zero_wake_convergence(wake,rotor,wake_inputs):
 
     return va, vt
 
-## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
+## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero
 def compute_dR_dpsi(B,beta,r,R,Wt,Wa,U,Ut,Ua,cos_psi,sin_psi,piece):
     """
     Computes the analytical derivative for the BEVW iteration.

diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py
@@ -1,8 +1,10 @@
-## @defgroup Methods-Propulsion-Rotor_Wake
+## @defgroup Methods-Propulsion-Rotor_Wake Rotor_Wake
 # Rotor_Wake provides the functions needed to perform analyses.
+# @ingroup Methods-Propulsion
 
-from . import Fidelity_Zero
 from . import Fidelity_One
+from . import Fidelity_Zero
+
 
 
 
diff --git a/trunk/SUAVE/Methods/Propulsion/__init__.py b/trunk/SUAVE/Methods/Propulsion/__init__.py
@@ -1,6 +1,7 @@
 ## @defgroup Methods-Propulsion Propulsion
 # Description
 # @ingroup Methods
+
 from . import Rotor_Wake
 from .ducted_fan_sizing import ducted_fan_sizing
 from .propeller_design import propeller_design

diff --git a/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py b/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py
@@ -1,4 +1,6 @@
 ## @defgroup Methods-Weights-Buildups-EVTOL EVTOL
+# The empty method that is called by the analysis
+# @ingroup Methods-Weights-Buildups
 
 """SUAVE.Methods.Weights.Buildups.EVTOL
    contains methods and attributes used for estimating

diff --git a/trunk/SUAVE/Plots/Geometry/__init__.py b/trunk/SUAVE/Plots/Geometry/__init__.py
@@ -1,6 +1,6 @@
 ## @defgroup Plots-Geometry Geometry
 # Description
-# @ingroup Plots-Geometry
+# @ingroup Plots
 
 from .plot_airfoil                  import plot_airfoil
 from .plot_propeller                import plot_propeller