Skip to content
This repository
Browse code

vl: improves comments (no more Doxygen warninigs).

  • Loading branch information...
commit a72f4c862b61945c0d35ebce67399ef6a6a90a13 1 parent f4cd6b9
Andrea Vedaldi vedaldi authored
20 vl/generic.h
@@ -38,16 +38,16 @@ GNU GPLv2, or (at your option) any later version.
38 38 /** @name Type identidifers for atomic data types
39 39 ** @{ */
40 40
41   -#define VL_TYPE_FLOAT 1
42   -#define VL_TYPE_DOUBLE 2
43   -#define VL_TYPE_INT8 3
44   -#define VL_TYPE_UINT8 4
45   -#define VL_TYPE_INT16 5
46   -#define VL_TYPE_UINT16 6
47   -#define VL_TYPE_INT32 7
48   -#define VL_TYPE_UINT32 8
49   -#define VL_TYPE_INT64 9
50   -#define VL_TYPE_UINT64 10
  41 +#define VL_TYPE_FLOAT 1 /**< @c float type */
  42 +#define VL_TYPE_DOUBLE 2 /**< @c double type */
  43 +#define VL_TYPE_INT8 3 /**< @c ::vl_int8 type */
  44 +#define VL_TYPE_UINT8 4 /**< @c ::vl_uint8 type */
  45 +#define VL_TYPE_INT16 5 /**< @c ::vl_int16 type */
  46 +#define VL_TYPE_UINT16 6 /**< @c ::vl_uint16 type */
  47 +#define VL_TYPE_INT32 7 /**< @c ::vl_int32 type */
  48 +#define VL_TYPE_UINT32 8 /**< @c ::vl_uint32 type */
  49 +#define VL_TYPE_INT64 9 /**< @c ::vl_int64 type */
  50 +#define VL_TYPE_UINT64 10 /**< @c ::vl_uint64 type */
51 51
52 52 typedef vl_uint32 vl_type ;
53 53
4 vl/host.c
@@ -239,8 +239,8 @@ GNU GPLv2, or (at your option) any later version.
239 239
240 240 @section Multi-threading host-threads
241 241
242   -The file defines ::VL_THREADS_WIN if multi-threading support is
243   -enabled and the host supports Windows threads and ::VL_THREADS_POSIX if
  242 +The file defines #VL_THREADS_WIN if multi-threading support is
  243 +enabled and the host supports Windows threads and #VL_THREADS_POSIX if
244 244 it supports POSIX threads.
245 245
246 246 **/
4 vl/kdtree.c
@@ -19,7 +19,7 @@ GNU GPLv2, or (at your option) any later version.
19 19
20 20 /** @file kdtree.h
21 21 **
22   - ** ::VlKDTree implements a KD-tree object data structure useful to
  22 + ** ::VlKDForest implements a KD-tree object data structure useful to
23 23 ** index moderately dimensional vector spaces. It can be used to
24 24 ** quickly match two groups of feature descriptors.
25 25 **
@@ -48,7 +48,7 @@ GNU GPLv2, or (at your option) any later version.
48 48 ** @section kdtree-tech Technical details
49 49 ** @sa @ref kdtree-references
50 50 **
51   - ** ::VlKDTree implements the best-bin-first kd-tree of [1].
  51 + ** ::VlKDForest implements the best-bin-first kd-tree of [1].
52 52 **
53 53 ** <b>Construction.</b> Given a set
54 54 ** of points @f$ x_1,\dots,x_n \in \mathbb{R}^d @f$, the algorithm
4 vl/pgm.c
@@ -156,10 +156,10 @@ vl_pgm_get_bpp (VlPgmImage const *im)
156 156 **
157 157 ** The function extracts from the file @a f the meta-data section of
158 158 ** an image encoded in PGM format. The function fills the structure
159   - ** VlPgmImage according.
  159 + ** ::VlPgmImage accordingly.
160 160 **
161 161 ** @return error code. The error may be either
162   - ** ::VL_PGM_INV_HEAD or ::VL_PGM_INV_META depending whether the error
  162 + ** #VL_PGM_INV_HEAD or #VL_PGM_INV_META depending whether the error
163 163 ** occurred in decoding the header or meta section of the PGM file.
164 164 **/
165 165
9 vl/pgm.h
@@ -34,18 +34,13 @@ GNU GPLv2, or (at your option) any later version.
34 34 ** whether #max_value is smaller than 256.
35 35 **/
36 36
37   -struct _VlPgmImage
  37 +typedef struct _VlPgmImage
38 38 {
39 39 int width ; /**< image width. */
40 40 int height ; /**< image height. */
41 41 int max_value ; /**< pixel maximum value (<= 2^16-1). */
42 42 vl_bool is_raw ; /**< is RAW format? */
43   -};
44   -
45   -/** @brief PGM image meta data type
46   - ** @see ::_VlPgmImage.
47   - **/
48   -typedef struct _VlPgmImage VlPgmImage ;
  43 +} VlPgmImage ;
49 44
50 45 /** @name Core operations
51 46 ** @{ */
2  vl/qsort-def.h
@@ -19,7 +19,7 @@ GNU GPLv2, or (at your option) any later version.
19 19
20 20 @section qsort-def-usage Usage
21 21
22   - ::qsort-def.h is used to define a specialization of the
  22 + @ref qsort-def.h is used to define a specialization of the
23 23 ::VL_QSORT_sort function that operatoes
24 24 on a given type of array. For instance the code
25 25
4 vl/quickshift.c
@@ -46,7 +46,7 @@ Parameter influencing the algorithm are:
46 46 estimated by using a Parzen window estimator with a Gaussian kernel of
47 47 the specified size (::vl_quickshift_set_kernel_size). The larger the
48 48 size, the larger the neighborhoods of pixels considered.
49   -- <b>Maximum distance.</b> This (::vl_set_max_dist) is the maximum
  49 +- <b>Maximum distance.</b> This (::vl_quickshift_set_max_dist) is the maximum
50 50 distance between two pixels that the algorithm considers when building
51 51 the forest. In principle, it can be infinity (so that a tree is
52 52 returned), but in practice it is much faster to consider only
@@ -62,7 +62,7 @@ for Mode Seeking&rdquo;, in <em>Proc. ECCV</em>, 2008.
62 62 can be reused for multiple images of the same size.
63 63 - Configure quick shift by setting the kernel size
64 64 (::vl_quickshift_set_kernel_size) and the maximum gap
65   - (::vl_quickshift_max_dist). The latter is in principle not
  65 + (::vl_quickshift_set_max_dist). The latter is in principle not
66 66 necessary, but useful to speedup processing.
67 67 - Process an image (::vl_quickshift_process).
68 68 - Retrieve the parents (::vl_quickshift_get_parents) and the distances
2  vl/random.c
@@ -35,7 +35,7 @@ GNU GPLv2, or (at your option) any later version.
35 35 The generator can be used to obtain random quantities of
36 36 various types:
37 37
38   - - ::vl_rand_int32, ::vl_rand_uint32 for 32-bit random integers;
  38 + - ::vl_rand_int31, ::vl_rand_uint32 for 32-bit random integers;
39 39 - ::vl_rand_real1 for a double in [0,1];
40 40 - ::vl_rand_real2 for a double in [0,1);
41 41 - ::vl_rand_real3 for a double in (0,1);
7 vl/sift.c
@@ -187,7 +187,7 @@ eight bins and the spatial coordinates into four each, as follows:
187 187
188 188 SIFT descriptors are computed by either calling
189 189 ::vl_sift_calc_keypoint_descriptor or
190   -::vl_sift_cal_keypoint_descriptor_raw. They accept as input a keypoint
  190 +::vl_sift_calc_raw_descriptor. They accept as input a keypoint
191 191 frame, which specifies the descriptor center, its size, and its
192 192 orientation on the image plane. The following parameters influence the
193 193 descriptor calculation:
@@ -778,9 +778,8 @@ copy_and_upsample_rows
778 778 /** ------------------------------------------------------------------
779 779 ** @internal
780 780 ** @brief Smooth an image
781   - **
782   - ** @parma self SIFT filter ;
783   - ** @param outImage output imgae buffer.
  781 + ** @param self SIFT filter.
  782 + ** @param outputImage output imgae buffer.
784 783 ** @param tempImage temporary image buffer.
785 784 ** @param inputImage input image buffer.
786 785 ** @param width input image width.
2  vl/sift.h
@@ -23,7 +23,7 @@ typedef float vl_sift_pix ;
23 23 ** @brief SIFT filter keypoint
24 24 **
25 25 ** This structure represent a keypoint as extracted by the SIFT
26   - ** filter ::VLSiftFilt.
  26 + ** filter ::VlSiftFilt.
27 27 **/
28 28
29 29 typedef struct _VlSiftKeypoint

0 comments on commit a72f4c8

Please sign in to comment.
Something went wrong with that request. Please try again.