Permalink
Browse files

vl: improves comments (no more Doxygen warninigs).

  • Loading branch information...
1 parent f4cd6b9 commit a72f4c862b61945c0d35ebce67399ef6a6a90a13 @vedaldi vedaldi committed Jun 3, 2011
Showing with 26 additions and 32 deletions.
  1. +10 −10 vl/generic.h
  2. +2 −2 vl/host.c
  3. +2 −2 vl/kdtree.c
  4. +2 −2 vl/pgm.c
  5. +2 −7 vl/pgm.h
  6. +1 −1 vl/qsort-def.h
  7. +2 −2 vl/quickshift.c
  8. +1 −1 vl/random.c
  9. +3 −4 vl/sift.c
  10. +1 −1 vl/sift.h
View
20 vl/generic.h
@@ -38,16 +38,16 @@ GNU GPLv2, or (at your option) any later version.
/** @name Type identidifers for atomic data types
** @{ */
-#define VL_TYPE_FLOAT 1
-#define VL_TYPE_DOUBLE 2
-#define VL_TYPE_INT8 3
-#define VL_TYPE_UINT8 4
-#define VL_TYPE_INT16 5
-#define VL_TYPE_UINT16 6
-#define VL_TYPE_INT32 7
-#define VL_TYPE_UINT32 8
-#define VL_TYPE_INT64 9
-#define VL_TYPE_UINT64 10
+#define VL_TYPE_FLOAT 1 /**< @c float type */
+#define VL_TYPE_DOUBLE 2 /**< @c double type */
+#define VL_TYPE_INT8 3 /**< @c ::vl_int8 type */
+#define VL_TYPE_UINT8 4 /**< @c ::vl_uint8 type */
+#define VL_TYPE_INT16 5 /**< @c ::vl_int16 type */
+#define VL_TYPE_UINT16 6 /**< @c ::vl_uint16 type */
+#define VL_TYPE_INT32 7 /**< @c ::vl_int32 type */
+#define VL_TYPE_UINT32 8 /**< @c ::vl_uint32 type */
+#define VL_TYPE_INT64 9 /**< @c ::vl_int64 type */
+#define VL_TYPE_UINT64 10 /**< @c ::vl_uint64 type */
typedef vl_uint32 vl_type ;
View
4 vl/host.c
@@ -239,8 +239,8 @@ GNU GPLv2, or (at your option) any later version.
@section Multi-threading host-threads
-The file defines ::VL_THREADS_WIN if multi-threading support is
-enabled and the host supports Windows threads and ::VL_THREADS_POSIX if
+The file defines #VL_THREADS_WIN if multi-threading support is
+enabled and the host supports Windows threads and #VL_THREADS_POSIX if
it supports POSIX threads.
**/
View
4 vl/kdtree.c
@@ -19,7 +19,7 @@ GNU GPLv2, or (at your option) any later version.
/** @file kdtree.h
**
- ** ::VlKDTree implements a KD-tree object data structure useful to
+ ** ::VlKDForest implements a KD-tree object data structure useful to
** index moderately dimensional vector spaces. It can be used to
** quickly match two groups of feature descriptors.
**
@@ -48,7 +48,7 @@ GNU GPLv2, or (at your option) any later version.
** @section kdtree-tech Technical details
** @sa @ref kdtree-references
**
- ** ::VlKDTree implements the best-bin-first kd-tree of [1].
+ ** ::VlKDForest implements the best-bin-first kd-tree of [1].
**
** <b>Construction.</b> Given a set
** of points @f$ x_1,\dots,x_n \in \mathbb{R}^d @f$, the algorithm
View
4 vl/pgm.c
@@ -156,10 +156,10 @@ vl_pgm_get_bpp (VlPgmImage const *im)
**
** The function extracts from the file @a f the meta-data section of
** an image encoded in PGM format. The function fills the structure
- ** VlPgmImage according.
+ ** ::VlPgmImage accordingly.
**
** @return error code. The error may be either
- ** ::VL_PGM_INV_HEAD or ::VL_PGM_INV_META depending whether the error
+ ** #VL_PGM_INV_HEAD or #VL_PGM_INV_META depending whether the error
** occurred in decoding the header or meta section of the PGM file.
**/
View
9 vl/pgm.h
@@ -34,18 +34,13 @@ GNU GPLv2, or (at your option) any later version.
** whether #max_value is smaller than 256.
**/
-struct _VlPgmImage
+typedef struct _VlPgmImage
{
int width ; /**< image width. */
int height ; /**< image height. */
int max_value ; /**< pixel maximum value (<= 2^16-1). */
vl_bool is_raw ; /**< is RAW format? */
-};
-
-/** @brief PGM image meta data type
- ** @see ::_VlPgmImage.
- **/
-typedef struct _VlPgmImage VlPgmImage ;
+} VlPgmImage ;
/** @name Core operations
** @{ */
View
2 vl/qsort-def.h
@@ -19,7 +19,7 @@ GNU GPLv2, or (at your option) any later version.
@section qsort-def-usage Usage
- ::qsort-def.h is used to define a specialization of the
+ @ref qsort-def.h is used to define a specialization of the
::VL_QSORT_sort function that operatoes
on a given type of array. For instance the code
View
4 vl/quickshift.c
@@ -46,7 +46,7 @@ Parameter influencing the algorithm are:
estimated by using a Parzen window estimator with a Gaussian kernel of
the specified size (::vl_quickshift_set_kernel_size). The larger the
size, the larger the neighborhoods of pixels considered.
-- <b>Maximum distance.</b> This (::vl_set_max_dist) is the maximum
+- <b>Maximum distance.</b> This (::vl_quickshift_set_max_dist) is the maximum
distance between two pixels that the algorithm considers when building
the forest. In principle, it can be infinity (so that a tree is
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.
can be reused for multiple images of the same size.
- Configure quick shift by setting the kernel size
(::vl_quickshift_set_kernel_size) and the maximum gap
- (::vl_quickshift_max_dist). The latter is in principle not
+ (::vl_quickshift_set_max_dist). The latter is in principle not
necessary, but useful to speedup processing.
- Process an image (::vl_quickshift_process).
- Retrieve the parents (::vl_quickshift_get_parents) and the distances
View
2 vl/random.c
@@ -35,7 +35,7 @@ GNU GPLv2, or (at your option) any later version.
The generator can be used to obtain random quantities of
various types:
- - ::vl_rand_int32, ::vl_rand_uint32 for 32-bit random integers;
+ - ::vl_rand_int31, ::vl_rand_uint32 for 32-bit random integers;
- ::vl_rand_real1 for a double in [0,1];
- ::vl_rand_real2 for a double in [0,1);
- ::vl_rand_real3 for a double in (0,1);
View
7 vl/sift.c
@@ -187,7 +187,7 @@ eight bins and the spatial coordinates into four each, as follows:
SIFT descriptors are computed by either calling
::vl_sift_calc_keypoint_descriptor or
-::vl_sift_cal_keypoint_descriptor_raw. They accept as input a keypoint
+::vl_sift_calc_raw_descriptor. They accept as input a keypoint
frame, which specifies the descriptor center, its size, and its
orientation on the image plane. The following parameters influence the
descriptor calculation:
@@ -778,9 +778,8 @@ copy_and_upsample_rows
/** ------------------------------------------------------------------
** @internal
** @brief Smooth an image
- **
- ** @parma self SIFT filter ;
- ** @param outImage output imgae buffer.
+ ** @param self SIFT filter.
+ ** @param outputImage output imgae buffer.
** @param tempImage temporary image buffer.
** @param inputImage input image buffer.
** @param width input image width.
View
2 vl/sift.h
@@ -23,7 +23,7 @@ typedef float vl_sift_pix ;
** @brief SIFT filter keypoint
**
** This structure represent a keypoint as extracted by the SIFT
- ** filter ::VLSiftFilt.
+ ** filter ::VlSiftFilt.
**/
typedef struct _VlSiftKeypoint

0 comments on commit a72f4c8

Please sign in to comment.