Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: update code docstrings #440

Merged
merged 3 commits into from
Sep 30, 2024
Merged

style: update code docstrings #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f2bed1
style: update code docstrings
vishwa2710 Sep 30, 2024
2ccb4b4
chore: fix
vishwa2710 Sep 30, 2024
165ff4f
chore: remove test
vishwa2710 Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Utility/ArrayCasting.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ struct type_caster<Array<T>> : list_caster<Array<T>, T>
{
};

// using list_caster::load ;
// using list_caster::cast ;
// using list_caster::load;
// using list_caster::cast;

} // namespace detail
} // namespace pybind11
8 changes: 4 additions & 4 deletions include/OpenSpaceToolkit/Astrodynamics/Conjunction/Message/CCSDS/CDM.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ class CDM
{
// OD Parameters

// String ODComment = String::Empty() ;
// String ODComment = String::Empty();
Instant timeLastObStart = Instant::Undefined();
Instant timeLastObEnd = Instant::Undefined();
Duration recommendedODSpan = Duration::Undefined();
Expand All @@ -171,7 +171,7 @@ class CDM

// Additional Parameters

// String additionParametersComment ;
// String additionParametersComment;
Real areaPC = Real::Undefined(); // Area, add Unit
Real areaDrag = Real::Undefined();
Real areaSRP = Real::Undefined();
Expand All @@ -183,12 +183,12 @@ class CDM

// State Vector

// String stateVectorComment ;
// String stateVectorComment;
State state;

// Covariance Matrix

// String covarianceComment ;
// String covarianceComment;
MatrixXd covarianceMatrix; // Usually defined in RTN Frame
};

Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/Dynamics.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class Dynamics
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << Dynamics(...) ;
/// std::cout << Dynamics(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/Dynamics/Tabulated.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class Tabulated : public Dynamics
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << Dynamics(...) ;
/// std::cout << Dynamics(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/EventCondition.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class EventCondition
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << EventCondition(...) ;
/// std::cout << EventCondition(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/Flight/Maneuver.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class Maneuver
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << Maneuver(...) ;
/// std::cout << Maneuver(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
28 changes: 14 additions & 14 deletions include/OpenSpaceToolkit/Astrodynamics/Flight/Profile.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ class Profile
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << Profile(...) ;
/// std::cout << Profile(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand All @@ -202,7 +202,7 @@ class Profile
/// @brief Check if profile is defined
///
/// @code{.cpp}
/// Profile(...).isDefined() ;
/// Profile(...).isDefined();
/// @endcode
///
/// @return True if profile is defined
Expand All @@ -211,9 +211,9 @@ class Profile
/// @brief Get state at a given instant
///
/// @code{.cpp}
/// Profile profile = { ... } ;
/// Instant instant = { ... } ;
/// State state = profile.getStateAt(instant) ;
/// Profile profile = { ... };
/// Instant instant = { ... };
/// State state = profile.getStateAt(instant);
/// @endcode
///
/// @param anInstant An instant
Expand All @@ -223,9 +223,9 @@ class Profile
/// @brief Get states at a given instants
///
/// @code{.cpp}
/// Profile profile = { ... } ;
/// Array<Instant> instants = { ... } ;
/// Array<State> state = profile.getStatesAt(instants) ;
/// Profile profile = { ... };
/// Array<Instant> instants = { ... };
/// Array<State> state = profile.getStatesAt(instants);
/// @endcode
///
/// @param anInstantArray An array of instants
Expand All @@ -235,9 +235,9 @@ class Profile
/// @brief Get axes at a given instant
///
/// @code{.cpp}
/// Profile profile = { ... } ;
/// Instant instant = { ... } ;
/// Axes axes = profile.getAxesAt(instant) ;
/// Profile profile = { ... };
/// Instant instant = { ... };
/// Axes axes = profile.getAxesAt(instant);
/// @endcode
///
/// @param anInstant An instant
Expand All @@ -253,8 +253,8 @@ class Profile
/// @brief Print flight profile to output stream
///
/// @code{.cpp}
/// Profile profile = { ... } ;
/// profile.print(std::cout, true) ;
/// Profile profile = { ... };
/// profile.print(std::cout, true);
/// @endcode
///
/// @param anOutputStream An output stream
Expand All @@ -264,7 +264,7 @@ class Profile
/// @brief Constructs an undefined flight profile
///
/// @code{.cpp}
/// Profile profile = Profile::Undefined() ; // Undefined
/// Profile profile = Profile::Undefined(); // Undefined
/// @endcode
///
/// @return Undefined profile
Expand Down
10 changes: 5 additions & 5 deletions include/OpenSpaceToolkit/Astrodynamics/Flight/System.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ class System
/// @brief Constructor
///
/// @code{.cpp}
/// Mass mass = { ... } ;
/// Composite composite ( ... ) ;
/// System system = { mass, composite } ;
/// Mass mass = { ... };
/// Composite composite ( ... );
/// System system = { mass, composite };
/// @endcode
///
/// @param aMass A mass
Expand Down Expand Up @@ -78,7 +78,7 @@ class System
/// @brief Get system's mass
///
/// @code{.cpp}
/// Mass mass = system.getMass() ;
/// Mass mass = system.getMass();
/// @endcode
///
/// @return Mass
Expand All @@ -87,7 +87,7 @@ class System
/// @brief Get system's geometry
///
/// @code{.cpp}
/// Mass mass = system.getGeometry() ;
/// Mass mass = system.getGeometry();
/// @endcode
///
/// @return Composite
Expand Down
24 changes: 12 additions & 12 deletions include/OpenSpaceToolkit/Astrodynamics/Flight/System/SatelliteSystem.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ class SatelliteSystem : public System
/// @brief Constructor
///
/// @code{.cpp}
/// Mass mass = { ... } ;
/// Composite composite ( ... ) ;
/// Matrix3d intertiaTensor ( ... ) ;
/// Real crossSectionalSurfaceArea = 0.8 ;
/// Real dragCoefficient = 2.2 ;
/// PropulsionSystem propulsionSystem = { ... } ;
/// Mass mass = { ... };
/// Composite composite ( ... );
/// Matrix3d intertiaTensor ( ... );
/// Real crossSectionalSurfaceArea = 0.8;
/// Real dragCoefficient = 2.2;
/// PropulsionSystem propulsionSystem = { ... };
/// System system = { mass, composite, intertiaTensor, crossSectionalSurfaceArea,
/// dragCoefficient, propulsionSystem } ;
/// dragCoefficient, propulsionSystem };
/// @endcode
///
/// @param aDryMass A dry mass (without propellant)
Expand Down Expand Up @@ -105,7 +105,7 @@ class SatelliteSystem : public System
/// @brief Access satellite system's propulsion system
///
/// @code{.cpp}
/// PropulsionSystem propulsionSystem = satelliteSystem.accessPropulsionSystem() ;
/// PropulsionSystem propulsionSystem = satelliteSystem.accessPropulsionSystem();
/// @endcode
///
/// @return PropulsionSystem
Expand All @@ -114,7 +114,7 @@ class SatelliteSystem : public System
/// @brief Get satellite system's inertia tensor
///
/// @code{.cpp}
/// Matrix3d inertiaTensor = satelliteSystem.getInertiaTensor() ;
/// Matrix3d inertiaTensor = satelliteSystem.getInertiaTensor();
/// @endcode
///
/// @return Matrix3d
Expand All @@ -123,7 +123,7 @@ class SatelliteSystem : public System
/// @brief Get satellite system's surface area
///
/// @code{.cpp}
/// Real surfaceArea = satelliteSystem.getCrossSectionalSurfaceArea() ;
/// Real surfaceArea = satelliteSystem.getCrossSectionalSurfaceArea();
/// @endcode
///
/// @return Real
Expand All @@ -132,7 +132,7 @@ class SatelliteSystem : public System
/// @brief Get satellite system's drag coefficient
///
/// @code{.cpp}
/// Real dragCoefficient = satelliteSystem.getDragCoefficient() ;
/// Real dragCoefficient = satelliteSystem.getDragCoefficient();
/// @endcode
///
/// @return Real
Expand All @@ -141,7 +141,7 @@ class SatelliteSystem : public System
/// @brief Get satellite system's propulsion system
///
/// @code{.cpp}
/// PropulsionSystem propulsionSystem = satelliteSystem.getPropulsionSystem() ;
/// PropulsionSystem propulsionSystem = satelliteSystem.getPropulsionSystem();
/// @endcode
///
/// @return PropulsionSystem
Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/GuidanceLaw.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class GuidanceLaw
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << GuidanceLaw(...) ;
/// std::cout << GuidanceLaw(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
2 changes: 1 addition & 1 deletion include/OpenSpaceToolkit/Astrodynamics/GuidanceLaw/QLaw.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ class QLaw : public GuidanceLaw
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << QLaw(...) ;
/// std::cout << QLaw(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand Down
38 changes: 19 additions & 19 deletions include/OpenSpaceToolkit/Astrodynamics/Trajectory.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ class Trajectory
/// @brief Constructor (model)
///
/// @code{.cpp}
/// Tabulated model = Tabulated::Load(File::Path(Path::Parse("/path/to/trajectory.csv"))) ;
/// Trajectory trajectory = { model } ;
/// Tabulated model = Tabulated::Load(File::Path(Path::Parse("/path/to/trajectory.csv")));
/// Trajectory trajectory = { model };
/// @endcode
///
/// @param aModel A trajectory model
Expand All @@ -50,8 +50,8 @@ class Trajectory
/// @brief Constructor (state array)
///
/// @code{.cpp}
/// Array<State> stateArray = { ... } ;
/// Trajectory trajectory = { stateArray } ;
/// Array<State> stateArray = { ... };
/// Trajectory trajectory = { stateArray };
/// @endcode
///
/// @param aStateArray An array of states
Expand All @@ -68,7 +68,7 @@ class Trajectory
/// @brief Equal to operator
///
/// @code{.cpp}
/// Trajectory(...) == Trajectory(...) ;
/// Trajectory(...) == Trajectory(...);
/// @endcode
///
/// @param aTrajectory A trajectory
Expand All @@ -78,7 +78,7 @@ class Trajectory
/// @brief Not equal to operator
///
/// @code{.cpp}
/// Trajectory(...) != Trajectory(...) ;
/// Trajectory(...) != Trajectory(...);
/// @endcode
///
/// @param aTrajectory A trajectory
Expand All @@ -88,7 +88,7 @@ class Trajectory
/// @brief Output stream operator
///
/// @code{.cpp}
/// std::cout << Trajectory(...) ;
/// std::cout << Trajectory(...);
/// @endcode
///
/// @param anOutputStream An output stream
Expand All @@ -99,7 +99,7 @@ class Trajectory
/// @brief Check if trajectory is defined
///
/// @code{.cpp}
/// Trajectory(...).isDefined() ;
/// Trajectory(...).isDefined();
/// @endcode
///
/// @return True if trajectory is defined
Expand All @@ -113,9 +113,9 @@ class Trajectory
/// @brief Get state at a given instant
///
/// @code{.cpp}
/// Trajectory trajectory = { ... } ;
/// Instant instant = { ... } ;
/// State state = trajectory.getStateAt(instant) ;
/// Trajectory trajectory = { ... };
/// Instant instant = { ... };
/// State state = trajectory.getStateAt(instant);
/// @endcode
///
/// @param anInstant An instant
Expand All @@ -125,9 +125,9 @@ class Trajectory
/// @brief Get states at a given instants
///
/// @code{.cpp}
/// Trajectory trajectory = { ... } ;
/// Array<Instant> instants = { ... } ;
/// Array<State> state = trajectory.getStatesAt(instants) ;
/// Trajectory trajectory = { ... };
/// Array<Instant> instants = { ... };
/// Array<State> state = trajectory.getStatesAt(instants);
/// @endcode
///
/// @param anInstantArray An array of instants
Expand All @@ -137,8 +137,8 @@ class Trajectory
/// @brief Print trajectory to output stream
///
/// @code{.cpp}
/// Trajectory trajectory = { ... } ;
/// trajectory.print(std::cout, true) ;
/// Trajectory trajectory = { ... };
/// trajectory.print(std::cout, true);
/// @endcode
///
/// @param anOutputStream An output stream
Expand All @@ -148,7 +148,7 @@ class Trajectory
/// @brief Constructs an undefined trajectory
///
/// @code{.cpp}
/// Trajectory trajectory = Trajectory::Undefined() ; // Undefined
/// Trajectory trajectory = Trajectory::Undefined(); // Undefined
/// @endcode
///
/// @return Undefined trajectory
Expand All @@ -157,8 +157,8 @@ class Trajectory
/// @brief Constructs a trajectory from a given position
///
/// @code{.cpp}
/// Position position = Position::Meters({ 0.0, 0.0, 0.0 }, Frame::GCRF()) ;
/// Trajectory trajectory = Trajectory::Position(position) ;
/// Position position = Position::Meters({ 0.0, 0.0, 0.0 }, Frame::GCRF());
/// Trajectory trajectory = Trajectory::Position(position);
/// @endcode
///
/// @param aPosition A position
Expand Down
Loading
Loading