Skip to content

Commit d92ee82

Browse files
committed
Fixed some issues with doxygen.
Minor changes.
1 parent 1898f9f commit d92ee82

File tree

14 files changed

+243
-186
lines changed

14 files changed

+243
-186
lines changed

LibDegorasSLR/includes/LibDegorasSLR/Astronomical/predictors/predictor_star_base.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ class LIBDPSLR_EXPORT PredictorStarBase
7676

7777
/**
7878
* @brief Constructs a PredictorStarBase object with the given observer's location.
79-
* @param star The parameters of the star.
80-
* @param loc The location of the observer.
81-
* @param leap_secs The leap seconds to apply.
82-
* @param ut1_utc_diff The difference between UT1 and UTC time systems to apply.
79+
* @param star The parameters of the star.
80+
* @param loc The location of the observer.
81+
* @param leap_secs The leap seconds to apply.
82+
* @param ut1_utc_diff The difference between UT1 and UTC time systems to apply.
8383
*/
8484
PredictorStarBase(const astro::types::Star& star,
8585
const geo::types::SurfaceLocation<math::units::Degrees>& loc,
@@ -100,19 +100,19 @@ class LIBDPSLR_EXPORT PredictorStarBase
100100
/**
101101
* @brief Predicts the position of a star at a specific time
102102
*
103-
* @param jdt The Julian DateTime object representing the Julian date and time of the prediction.
104-
* @param refraction True if refraction model is to be applied, false otherwise.
103+
* @param jdt The Julian DateTime object representing the Julian date and time of the prediction.
104+
* @param refraction True if refraction model is to be applied, false otherwise.
105105
* @return The resulting PredictionStar.
106106
*/
107107
virtual PredictionStar predict(const timing::dates::JDateTime& jdt, bool refraction) const = 0;
108108

109109
/**
110110
* @brief Predicts star positions within a time range with a specified time step.
111111
*
112-
* @param jdt_start The Julian start datetime of the prediction range.
113-
* @param jdt_end The Julian end datetime of ñthe prediction range.
114-
* @param step The time step in milliseconds between predictions.
115-
* @param refraction True if refraction model is to be applied, false otherwise.
112+
* @param jdt_start The Julian start datetime of the prediction range.
113+
* @param jdt_end The Julian end datetime of ñthe prediction range.
114+
* @param step The time step in milliseconds between predictions.
115+
* @param refraction True if refraction model is to be applied, false otherwise.
116116
* @return A vector of StarPrediction objects representing predicted star positions at each step.
117117
*
118118
* @throws std::invalid_argument If the interval is invalid.

LibDegorasSLR/includes/LibDegorasSLR/FormatsILRS/cpf/records/cpf_data.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ class LIBDPSLR_EXPORT CPFData
111111
{
112112
/**
113113
* @brief PositionRecord constructor from a generic ConsolidatedRecord.
114-
* @param rec, the consolidated record.
114+
* @param rec The consolidated record.
115115
*/
116116
PositionRecord(const common::ConsolidatedRecord& rec);
117117

@@ -140,7 +140,7 @@ class LIBDPSLR_EXPORT CPFData
140140
{
141141
/**
142142
* @brief VelocityRecord constructor from a generic ConsolidatedRecord.
143-
* @param rec, the consolidated record.
143+
* @param rec The consolidated record.
144144
*/
145145
VelocityRecord(const common::ConsolidatedRecord& rec);
146146

@@ -166,7 +166,7 @@ class LIBDPSLR_EXPORT CPFData
166166
{
167167
/**
168168
* @brief CorrectionsRecord constructor from a generic ConsolidatedRecord.
169-
* @param rec, the consolidated record.
169+
* @param rec The consolidated record.
170170
*/
171171
CorrectionsRecord(const common::ConsolidatedRecord& rec);
172172

@@ -333,37 +333,37 @@ class LIBDPSLR_EXPORT CPFData
333333
// Records individual setter methods.
334334
/**
335335
* @brief Adds a position record to the end of the current list of position records.
336-
* @param rec, the position record to append.
336+
* @param rec The position record to append.
337337
*/
338338
void addPositionRecord(const PositionRecord &rec);
339339
/**
340340
* @brief Adds a velocity record to the end of the current list of velocity records.
341-
* @param rec, the velocity record to append.
341+
* @param rec The velocity record to append.
342342
*/
343343
void addVelocityRecord(const VelocityRecord &rec);
344344
/**
345345
* @brief Adds a corrections record to the end of the current list of corrections records.
346-
* @param rec, the corretions record to append.
346+
* @param rec The corretions record to append.
347347
*/
348348
void addCorrectionsRecord(const CorrectionsRecord &rec);
349349
/**
350350
* @brief Adds a transponder record to the end of the current list of transponder records.
351-
* @param rec, the transponder record to append.
351+
* @param rec The transponder record to append.
352352
*/
353353
void addTransponderRecord(const TransponderRecord &rec);
354354
/**
355355
* @brief Adds an offset from center record to the end of the current list of offset from center records.
356-
* @param rec, the offset from center record to append.
356+
* @param rec The offset from center record to append.
357357
*/
358358
void addOffsetFromCenterRecord(const OffsetFromCenterRecord &rec);
359359
/**
360360
* @brief Adds a rotation angle record to the end of the current list of rotation angle records.
361-
* @param rec, the rotation angle record to append.
361+
* @param rec The rotation angle record to append.
362362
*/
363363
void addRotationAngleRecord(const RotationAngleRecord &rec);
364364
/**
365365
* @brief Adds an earth orientation record to the end of the current list of earth orientation records.
366-
* @param rec, the earth orientation record to append.
366+
* @param rec The earth orientation record to append.
367367
*/
368368
void addEarthOrientationRecord(const EarthOrientationRecord &rec);
369369

LibDegorasSLR/includes/LibDegorasSLR/FormatsILRS/cpf/records/cpf_header.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -306,43 +306,43 @@ class LIBDPSLR_EXPORT CPFHeader
306306
// Generic read methods.
307307
/**
308308
* @brief Read header records.
309-
* @param rec_v, vector with header records.
309+
* @param rec_v Vector with header records.
310310
* @return The errors generated at reading.
311311
*/
312312
common::RecordReadErrorMultimap readHeader(const common::RecordLinesVector &rec_v);
313313

314314
// Specific read methods.
315315
/**
316316
* @brief Read Basic Info 1 Header H1 from record.
317-
* @param rec, the record to read from.
317+
* @param rec The record to read from.
318318
* @return The error generated at reading.
319319
*/
320320
common::RecordReadError readBasicInfo1Header(const common::ConsolidatedRecord &rec);
321321

322322
/**
323323
* @brief Read Basic Info 2 Header H2 from record.
324-
* @param rec, the record to read from.
324+
* @param rec The record to read from.
325325
* @return The error generated at reading.
326326
*/
327327
common::RecordReadError readBasicInfo2Header(const common::ConsolidatedRecord &rec);
328328

329329
/**
330330
* @brief Read Expected Accuracy H3 from record.
331-
* @param rec, the record to read from.
331+
* @param rec The record to read from.
332332
* @return The error generated at reading.
333333
*/
334334
common::RecordReadError readExpectedAccuracyHeader(const common::ConsolidatedRecord &rec);
335335

336336
/**
337337
* @brief Read Transponder Info H4 from record.
338-
* @param rec, the record to read from.
338+
* @param rec The record to read from.
339339
* @return The error generated at reading.
340340
*/
341341
common::RecordReadError readTransponderInfoHeader(const common::ConsolidatedRecord &rec);
342342

343343
/**
344344
* @brief Read Center of Mass Correction H5 from record.
345-
* @param rec, the record to read from.
345+
* @param rec The record to read from.
346346
* @return The error generated at reading.
347347
*/
348348
common::RecordReadError readCoMCorrectionHeader(const common::ConsolidatedRecord &rec);

0 commit comments

Comments
 (0)