Basic doxygen documentation support

- updated existing Doxyfile.in
- added corresponding cmake instructions
- added some specific files (layout, icon)
- clean existing doxygen warnings
This commit is contained in:
Maksim Shabunin
2014-10-09 14:04:00 +04:00
parent e40567eaee
commit ba5f343c38
17 changed files with 520 additions and 186 deletions

View File

@@ -57,14 +57,14 @@ namespace cvflann {
class DynamicBitset
{
public:
/** @param default constructor
/** default constructor
*/
DynamicBitset()
{
}
/** @param only constructor we use in our code
* @param the size of the bitset (in bits)
/** only constructor we use in our code
* @param sz the size of the bitset (in bits)
*/
DynamicBitset(size_t sz)
{
@@ -87,7 +87,7 @@ public:
return bitset_.empty();
}
/** @param set all the bits to 0
/** set all the bits to 0
*/
void reset()
{
@@ -95,7 +95,7 @@ public:
}
/** @brief set one bit to 0
* @param
* @param index
*/
void reset(size_t index)
{
@@ -106,15 +106,15 @@ public:
* This function is useful when resetting a given set of bits so that the
* whole bitset ends up being 0: if that's the case, we don't care about setting
* other bits to 0
* @param
* @param index
*/
void reset_block(size_t index)
{
bitset_[index / cell_bit_size_] = 0;
}
/** @param resize the bitset so that it contains at least size bits
* @param size
/** resize the bitset so that it contains at least sz bits
* @param sz
*/
void resize(size_t sz)
{
@@ -122,7 +122,7 @@ public:
bitset_.resize(sz / cell_bit_size_ + 1);
}
/** @param set a bit to true
/** set a bit to true
* @param index the index of the bit to set to 1
*/
void set(size_t index)
@@ -130,14 +130,14 @@ public:
bitset_[index / cell_bit_size_] |= size_t(1) << (index % cell_bit_size_);
}
/** @param gives the number of contained bits
/** gives the number of contained bits
*/
size_t size() const
{
return size_;
}
/** @param check if a bit is set
/** check if a bit is set
* @param index the index of the bit to check
* @return true if the bit is set
*/

View File

@@ -153,8 +153,10 @@ public:
* @param feature_size is the size of the feature (considered as a ElementType[])
* @param key_size is the number of bits that are turned on in the feature
*/
LshTable(unsigned int /*feature_size*/, unsigned int /*key_size*/)
LshTable(unsigned int feature_size, unsigned int key_size)
{
(void)feature_size;
(void)key_size;
std::cerr << "LSH is not implemented for that type" << std::endl;
assert(0);
}

View File

@@ -449,7 +449,7 @@ class RadiusUniqueResultSet : public UniqueResultSet<DistanceType>
{
public:
/** Constructor
* @param capacity the number of neighbors to store at max
* @param radius the maximum distance of a neighbor
*/
RadiusUniqueResultSet(DistanceType radius) :
radius_(radius)
@@ -509,6 +509,7 @@ class KNNRadiusUniqueResultSet : public KNNUniqueResultSet<DistanceType>
public:
/** Constructor
* @param capacity the number of neighbors to store at max
* @param radius the maximum distance of a neighbor
*/
KNNRadiusUniqueResultSet(unsigned int capacity, DistanceType radius)
{