Skip to content
This repository was archived by the owner on Apr 13, 2021. It is now read-only.

Commit abbbc8c

Browse files
kovachkovach
committed
fix doxygen warnings
1 parent 6bcf546 commit abbbc8c

18 files changed

+56
-148
lines changed

‎CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ set(ALLOWED_DOXYGEN_WARNINGS ${PROJECT_SOURCE_DIR}/checks/allowed_doxygen_warnin
8383
# TODO add srcs dependency
8484
add_custom_target(check-doxygen
8585
COMMAND diff ${ALLOWED_DOXYGEN_WARNINGS} ${DOXYGEN_WARNINGS}
86-
DEPENDS docs)
86+
DEPENDS docs swiftnav-static)
8787

8888
add_custom_target(check-style DEPENDS check-doxygen checkpatch)

‎checks/allowed_doxygen_warnings.txt‎

Lines changed: 0 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +0,0 @@
1-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: argument 'mat1' of command @param is not found in the argument list of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2)
2-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: argument 'mat2' of command @param is not found in the argument list of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2)
3-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: The following parameters of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2) are not documented:
4-
parameter 'Z_inv1'
5-
parameter 'Z_inv2'
6-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/dgnss_management.c:399: warning: The following parameters of dgnss_baseline(u8 num_sdiffs, const sdiff_t *sdiffs, const double ref_ecef[3], const ambiguity_state_t *s, u8 *num_used, double b[3], bool disable_raim, double raim_threshold) are not documented:
7-
parameter 's'
8-
parameter 'disable_raim'
9-
parameter 'raim_threshold'
10-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ephemeris.c:157: warning: The following parameters of ephemeris_good(ephemeris_t *eph, gps_time_t t) are not documented:
11-
parameter 't'
12-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/gpstime.c:45: warning: argument 't' of command @param is not found in the argument list of gps2time(gps_time_t gps_t)
13-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/gpstime.c:45: warning: The following parameters of gps2time(gps_time_t gps_t) are not documented:
14-
parameter 'gps_t'
15-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:84: warning: argument 'mat1' of command @param is not found in the argument list of print_s32_mtx(s32 *mat, u32 m, u32 n)
16-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:84: warning: The following parameters of print_s32_mtx(s32 *mat, u32 m, u32 n) are not documented:
17-
parameter 'mat'
18-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: argument 'mat1' of command @param is not found in the argument list of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2)
19-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: argument 'mat2' of command @param is not found in the argument list of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2)
20-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:63: warning: The following parameters of print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2) are not documented:
21-
parameter 'Z_inv1'
22-
parameter 'Z_inv2'
23-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/dgnss_management.c:399: warning: The following parameters of dgnss_baseline(u8 num_sdiffs, const sdiff_t *sdiffs, const double ref_ecef[3], const ambiguity_state_t *s, u8 *num_used, double b[3], bool disable_raim, double raim_threshold) are not documented:
24-
parameter 's'
25-
parameter 'disable_raim'
26-
parameter 'raim_threshold'
27-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ephemeris.c:157: warning: The following parameters of ephemeris_good(ephemeris_t *eph, gps_time_t t) are not documented:
28-
parameter 't'
29-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/gpstime.c:45: warning: argument 't' of command @param is not found in the argument list of gps2time(gps_time_t gps_t)
30-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/gpstime.c:45: warning: The following parameters of gps2time(gps_time_t gps_t) are not documented:
31-
parameter 'gps_t'
32-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:84: warning: argument 'mat1' of command @param is not found in the argument list of print_s32_mtx(s32 *mat, u32 m, u32 n)
33-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/printing_utils.c:84: warning: The following parameters of print_s32_mtx(s32 *mat, u32 m, u32 n) are not documented:
34-
parameter 'mat'
35-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ambiguity_test.c:286: warning: argument 'float_sats' of command @param is not found in the argument list of update_ambiguity_test(double ref_ecef[3], double phase_var, double code_var, ambiguity_test_t *amb_test, u8 state_dim, sdiff_t *sdiffs, u8 changed_sats)
36-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ambiguity_test.c:286: warning: argument 'float_mean' of command @param is not found in the argument list of update_ambiguity_test(double ref_ecef[3], double phase_var, double code_var, ambiguity_test_t *amb_test, u8 state_dim, sdiff_t *sdiffs, u8 changed_sats)
37-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ambiguity_test.c:286: warning: argument 'float_cov_U' of command @param is not found in the argument list of update_ambiguity_test(double ref_ecef[3], double phase_var, double code_var, ambiguity_test_t *amb_test, u8 state_dim, sdiff_t *sdiffs, u8 changed_sats)
38-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ambiguity_test.c:286: warning: argument 'float_cov_D' of command @param is not found in the argument list of update_ambiguity_test(double ref_ecef[3], double phase_var, double code_var, ambiguity_test_t *amb_test, u8 state_dim, sdiff_t *sdiffs, u8 changed_sats)
39-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/ambiguity_test.c:286: warning: The following parameters of update_ambiguity_test(double ref_ecef[3], double phase_var, double code_var, ambiguity_test_t *amb_test, u8 state_dim, sdiff_t *sdiffs, u8 changed_sats) are not documented:
40-
parameter 'changed_sats'
41-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/baseline.c:543: warning: The following parameters of baseline_(u8 num_sdiffs, const sdiff_t *sdiffs, const double ref_ecef[3], u8 num_ambs, const u8 *amb_prns, const double *ambs, u8 *num_used, double b[3], bool disable_raim, double raim_threshold) are not documented:
42-
parameter 'disable_raim'
43-
parameter 'raim_threshold'
44-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/baseline.c:508: warning: argument 'kf' of command @param is not found in the argument list of least_squares_solve_b_external_ambs(u8 num_dds_u8, const double *state_mean, const sdiff_t *sdiffs_with_ref_first, const double *dd_measurements, const double ref_ecef[3], double b[3], bool disable_raim, double raim_threshold)
45-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/baseline.c:508: warning: The following parameters of least_squares_solve_b_external_ambs(u8 num_dds_u8, const double *state_mean, const sdiff_t *sdiffs_with_ref_first, const double *dd_measurements, const double ref_ecef[3], double b[3], bool disable_raim, double raim_threshold) are not documented:
46-
parameter 'num_dds_u8'
47-
parameter 'state_mean'
48-
parameter 'disable_raim'
49-
parameter 'raim_threshold'
50-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/baseline.c:185: warning: argument 'num_dds' of command @param is not found in the argument list of lesq_solution_float(u8 num_dds_u8, const double *dd_obs, const double *N, const double *DE, double b[3], double *resid)
51-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/baseline.c:185: warning: The following parameters of lesq_solution_float(u8 num_dds_u8, const double *dd_obs, const double *N, const double *DE, double b[3], double *resid) are not documented:
52-
parameter 'num_dds_u8'
53-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/bits.c:59: warning: The following parameters of getbits(const u8 *buff, u32 pos, u8 len) are not documented:
54-
parameter 'buff'
55-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/bits.c:39: warning: The following parameters of getbitu(const u8 *buff, u32 pos, u8 len) are not documented:
56-
parameter 'buff'
57-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/bits.c:103: warning: The following parameters of setbits(u8 *buff, u32 pos, u32 len, s32 data) are not documented:
58-
parameter 'buff'
59-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/bits.c:80: warning: The following parameters of setbitu(u8 *buff, u32 pos, u32 len, u32 data) are not documented:
60-
parameter 'buff'
61-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/coord_system.c:56: warning: Found unknown command `\frac'
62-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/coord_system.c:56: warning: Found unknown command `\pi'
63-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/coord_system.c:36: warning: Found unknown command `\frac'
64-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/coord_system.c:36: warning: Found unknown command `\pi'
65-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/linear_algebra.c:92: warning: argument 'A' of command @param is not found in the argument list of qrdecomp_square(const double *a, u32 rows, double *qt, double *r)
66-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/linear_algebra.c:92: warning: The following parameters of qrdecomp_square(const double *a, u32 rows, double *qt, double *r) are not documented:
67-
parameter 'a'
68-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/linear_algebra.c:960: warning: argument 'n' of command @param is not found in the argument list of vector_cross(const double a[3], const double b[3], double c[3])
69-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/include/libswiftnav/logging.h:33: warning: explicit link request to 'define' could not be resolved
70-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/memory_pool.c:409: warning: The following parameters of memory_pool_filter(memory_pool_t *pool, void *arg, s8(*f)(void *arg, element_t *elem)) are not documented:
71-
parameter 'arg'
72-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/memory_pool.c:84: warning: argument 'pool' of command @param is not found in the argument list of memory_pool_init(memory_pool_t *new_pool, u32 n_elements, size_t element_size, void *buff)
73-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/memory_pool.c:84: warning: The following parameters of memory_pool_init(memory_pool_t *new_pool, u32 n_elements, size_t element_size, void *buff) are not documented:
74-
parameter 'new_pool'
75-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/memory_pool.c:276: warning: The following parameters of memory_pool_map(memory_pool_t *pool, void *arg, void(*f)(void *arg, element_t *elem)) are not documented:
76-
parameter 'arg'
77-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/observation.c:138: warning: The following parameters of make_propagated_sdiffs(u8 n_local, navigation_measurement_t *m_local, u8 n_remote, navigation_measurement_t *m_remote, double *remote_dists, double remote_pos_ecef[3], ephemeris_t *es, gps_time_t t, sdiff_t *sds) are not documented:
78-
parameter 'es'
79-
parameter 't'
80-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/observation.c:75: warning: Found unknown command `\oaram'
81-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/observation.c:77: warning: Found unknown command `\oaram'
82-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/observation.c:67: warning: The following parameters of single_diff(u8 n_a, navigation_measurement_t *m_a, u8 n_b, navigation_measurement_t *m_b, sdiff_t *sds) are not documented:
83-
parameter 'm_a'
84-
parameter 'm_b'
85-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/set.c:154: warning: The following parameters of intersection(u32 na, size_t sa, const void *as, void *a_out, u32 nb, size_t sb, const void *bs, void *b_out, cmp_fn cmp) are not documented:
86-
parameter 'bs'
87-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/set.c:74: warning: The following parameters of intersection_map(u32 na, size_t sa, const void *as, u32 nb, size_t sb, const void *bs, cmp_fn cmp, void *context, void(*f)(void *context, u32 n, const void *a, const void *b)) are not documented:
88-
parameter 'bs'
89-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:821: warning: Found unknown command `\oaram'
90-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:823: warning: Found unknown command `\oaram'
91-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:816: warning: argument 'm_tdcp' of command @param is not found in the argument list of tdcp_doppler(u8 n_new, navigation_measurement_t *m_new, u8 n_old, navigation_measurement_t *m_old, navigation_measurement_t *m_corrected)
92-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:816: warning: The following parameters of tdcp_doppler(u8 n_new, navigation_measurement_t *m_new, u8 n_old, navigation_measurement_t *m_old, navigation_measurement_t *m_corrected) are not documented:
93-
parameter 'm_new'
94-
parameter 'm_old'
95-
parameter 'm_corrected'
96-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:289: warning: The following parameters of aided_tl_init(aided_tl_state_t *s, float loop_freq, float code_freq, float code_bw, float code_zeta, float code_k, float carr_to_code, float carr_freq, float carr_bw, float carr_zeta, float carr_k, float carr_freq_b1) are not documented:
97-
parameter 'carr_freq_b1'
98-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:432: warning: The following parameters of comp_tl_init(comp_tl_state_t *s, float loop_freq, float code_freq, float code_bw, float code_zeta, float code_k, float carr_freq, float carr_bw, float carr_zeta, float carr_k, float tau, float cpc, u32 sched) are not documented:
99-
parameter 'loop_freq'
100-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:144: warning: The following parameters of frequency_discriminator(float I, float Q, float prev_I, float prev_Q) are not documented:
101-
parameter 'prev_I'
102-
parameter 'prev_Q'
103-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:565: warning: The following parameters of lock_detect_init(lock_detect_t *l, float k1, float k2, u16 lp, u16 lo) are not documented:
104-
parameter 'l'
105-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:577: warning: The following parameters of lock_detect_reinit(lock_detect_t *l, float k1, float k2, u16 lp, u16 lo) are not documented:
106-
parameter 'l'
107-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:600: warning: The following parameters of lock_detect_update(lock_detect_t *l, float I, float Q, float DT) are not documented:
108-
parameter 'l'
109-
/Users/scott/swiftnav/test-plover-qr-pvt/libswiftnav/src/track.c:379: warning: The following parameters of simple_tl_init(simple_tl_state_t *s, float loop_freq, float code_freq, float code_bw, float code_zeta, float code_k, float carr_freq, float carr_bw, float carr_zeta, float carr_k) are not documented:
110-
parameter 'loop_freq'

‎include/libswiftnav/ambiguity_test.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ typedef struct {
7373
z_t *Z_new_inv;
7474
} generate_hypothesis_state_t2;
7575

76-
void print_s32_mtx_diff(u32 m, u32 n, s32 *Z_inv1, s32 *Z_inv2);
7776
s8 get_single_hypothesis(ambiguity_test_t *amb_test, s32 *hyp_N);
7877
void create_empty_ambiguity_test(ambiguity_test_t *amb_test);
7978
void create_ambiguity_test(ambiguity_test_t *amb_test);

‎include/libswiftnav/logging.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* on a per-file basis by adding the following line to the source file *before*
3030
* including `logging.h`:
3131
*
32-
* #define DEBUG 1
32+
* \#define DEBUG 1
3333
*
3434
* \{ */
3535

‎include/libswiftnav/printing_utils.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#ifndef LIBSWIFTNAV_PRINTING_UTILS_H
1414
#define LIBSWIFTNAV_PRINTING_UTILS_H
1515

16-
void print_s32_mtx_diff(u32 m, u32 n, s32 *mat1, s32 *mat2)
16+
void print_s32_mtx_diff(u32 m, u32 n, s32 *mat1, s32 *mat2);
1717
void print_hyp(void *arg, element_t *elem);
1818
void print_double_mtx(double *m, u32 _r, u32 _c);
1919
void print_pearson_mtx(double *m, u32 dim);

‎src/ambiguity_test.c‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,11 +296,8 @@ void ambiguity_test_MLE_ambs(ambiguity_test_t *amb_test, s32 *ambs)
296296
* \param code_var The variance of the code pseudorange measurements.
297297
* \param amb_test The ambiguity test to update.
298298
* \param state_dim The dimension of the float state.
299-
* \param float_sats The satellites being represented in the float state.
300299
* \param sdiffs The single differenced measurements/sat positions of all sats tracked.
301-
* \param float_mean The float estimate of the integer ambiguities.
302-
* \param float_cov_U The U in the UDU' decomposition of the covariance of the float estimate.
303-
* \param float_cov_D The D in the UDU' decomposition of the covariance of the float estimate.
300+
* \param changed_sats Not currently used.
304301
*
305302
* INVALIDATES unanimous ambiguities
306303
*/

‎src/baseline.c‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -217,18 +217,18 @@ void amb_from_baseline(u8 num_dds, const double *DE, const double *dd_obs,
217217
* \note This function takes real valued carrier phase ambiguities. For integer
218218
* valued ambiguities, see lesq_solution_int().
219219
*
220-
* \param num_dds Number of double difference observations
221-
* \param dd_obs Double differenced carrier phase observations in cycles,
222-
* length `num_dds`
223-
* \param N Carrier phase ambiguity vector, length `num_dds`
224-
* \param DE Double differenced matrix of unit vectors to the satellites,
225-
* length `3 * num_dds`
226-
* \param b The output baseline in meters.
227-
* \param resid The output least squares residuals in cycles.
228-
* \return 0 on success,
229-
* -1 if there were insufficient observations to calculate the
230-
* baseline (the solution was under-constrained),
231-
* -2 if an error occurred
220+
* \param num_dds_u8 Number of double difference observations
221+
* \param dd_obs Double differenced carrier phase observations in cycles,
222+
* length `num_dds`
223+
* \param N Carrier phase ambiguity vector, length `num_dds`
224+
* \param DE Double differenced matrix of unit vectors to the satellites,
225+
* length `3 * num_dds`
226+
* \param b The output baseline in meters.
227+
* \param resid The output least squares residuals in cycles.
228+
* \return 0 on success,
229+
* -1 if there were insufficient observations to calculate the
230+
* baseline (the solution was under-constrained),
231+
* -2 if an error occurred
232232
*/
233233
s8 lesq_solution_float(u8 num_dds_u8, const double *dd_obs, const double *N,
234234
const double *DE, double b[3], double *resid)
@@ -508,7 +508,8 @@ s8 lesq_solve_raim(u8 num_dds_u8, const double *dd_obs,
508508
* This uses the current state of the KF and a set of phase observations to
509509
* solve for the current baseline.
510510
*
511-
* \param kf The Kalman filter struct.
511+
* \param num_dds_u8 State dimension
512+
* \param state_mean KF estimated state mean
512513
* \param sdiffs_with_ref_first A list of sdiffs. The first in the list must be
513514
* the reference sat of the KF, and the rest must
514515
* correspond to the KF's DD amb estimates' sats,
@@ -519,6 +520,8 @@ s8 lesq_solve_raim(u8 num_dds_u8, const double *dd_obs,
519520
* \param ref_ecef The reference position in ECEF frame, for
520521
* computing the sat direction vectors.
521522
* \param b The output baseline in meters.
523+
* \param disable_raim True disables raim check/repair
524+
* \param raim_threshold Threshold for raim checks.
522525
* \return See lesq_solve_raim()
523526
*/
524527
s8 least_squares_solve_b_external_ambs(u8 num_dds_u8, const double *state_mean,
@@ -555,6 +558,8 @@ s8 least_squares_solve_b_external_ambs(u8 num_dds_u8, const double *state_mean,
555558
* \param num_used Pointer to where to store number of satellites used in the
556559
* baseline solution
557560
* \param b The output baseline in meters
561+
* \param disable_raim True disables raim check/repair
562+
* \param raim_threshold Threshold for raim checks.
558563
* \return 0 on success,
559564
* -1 if there were insufficient observations to calculate the
560565
* baseline (the solution was under-constrained),

0 commit comments

Comments
 (0)