Skip to content

Commit b773b20

Browse files
committed
Fixed minor doxygen warnings
1 parent 8cadbe0 commit b773b20

File tree

5 files changed

+21
-24
lines changed

5 files changed

+21
-24
lines changed

src/bm.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1951,8 +1951,8 @@ class bvector
19511951
\param rank - rank to find (bitcount)
19521952
\param from - start positioon for rank search
19531953
\param pos - position with speciefied rank (relative to from position)
1954-
\param blocks_cnt - block count structure to accelerate rank search
1955-
should be prepared using build_rs_index
1954+
\param rs_idx - rank-select index to accelarate search
1955+
(should be prepared using build_rs_index)
19561956
19571957
\sa build_rs_index, select
19581958

src/bmfunc.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -525,9 +525,7 @@ unsigned short bitscan_popcnt(bm::id_t w, B* bits)
525525
\brief Unpacks 64-bit word into list of ON bit indexes using popcnt method
526526
\param w - value
527527
\param bits - pointer on the result array
528-
\param offs - bit address offset to add (0 - default)
529528
\return number of bits in the list
530-
531529
@ingroup bitfunc
532530
*/
533531
template<typename B>
@@ -1073,9 +1071,7 @@ bool gap_is_all_zero(const bm::gap_word_t* buf)
10731071
/*!
10741072
\brief Checks if GAP block is all-one.
10751073
\param buf - GAP buffer pointer.
1076-
\param set_max - max possible bitset length
10771074
\returns true if all-one.
1078-
10791075
@ingroup gapfunc
10801076
*/
10811077
BMFORCEINLINE
@@ -2584,7 +2580,8 @@ unsigned gap_add_value(T* buf, unsigned pos)
25842580
/*!
25852581
@brief Right shift GAP block by 1 bit
25862582
@param buf - block pointer
2587-
@param co_falg - carry over from the previous block
2583+
@param co_flag - carry over from the previous block
2584+
@param new_len - output length of the GAP block after the operation
25882585
25892586
@return carry over bit (1 or 0)
25902587
@ingroup gapfunc
@@ -2631,8 +2628,9 @@ bool gap_shift_r1(T* buf, unsigned co_flag, unsigned* new_len)
26312628
/*!
26322629
@brief Left shift GAP block by 1 bit
26332630
@param buf - block pointer
2634-
@param co_falg - carry over from the previous block
2635-
2631+
@param co_flag - carry over from the previous block
2632+
@param new_len - new length of the block
2633+
26362634
@return carry over bit (1 or 0)
26372635
@ingroup gapfunc
26382636
*/
@@ -6117,7 +6115,10 @@ bool bit_block_or_3way(bm::word_t* BMRESTRICT dst,
61176115
Function does not analyse availability of source and destination blocks.
61186116
61196117
\param dst - destination block.
6120-
\param src1 - source1, etc
6118+
\param src1 - source1, etc
6119+
\param src2 - source1, etc
6120+
\param src3 - source1, etc
6121+
\param src4 - source1, etc
61216122
61226123
@return 1 if produced block of ALL ones
61236124
@@ -6320,8 +6321,8 @@ bm::id64_t bit_block_sub(bm::word_t* BMRESTRICT dst,
63206321
\brief digest based bitblock SUB (AND NOT) operation (3 operand)
63216322
63226323
\param dst - destination block.
6323-
\param src1 - source block.
6324-
\param src1 - source block.
6324+
\param src1 - source block 1
6325+
\param src2 - source block 2
63256326
\param digest - known digest of dst block
63266327
63276328
\return new digest
@@ -6556,7 +6557,6 @@ bm::word_t* bit_operation_xor(bm::word_t* BMRESTRICT dst,
65566557
\brief Performs bitblock XOR operation and calculates bitcount of the result.
65576558
65586559
\param src1 - bit block start ptr
6559-
\param src1_end - bit block end ptr
65606560
\param src2 - second bit block
65616561
65626562
\returns bitcount value
@@ -7753,7 +7753,7 @@ void set_block_bits_u32(bm::word_t* BMRESTRICT block,
77537753

77547754
/**
77557755
@brief array range detector
7756-
@intenal
7756+
@internal
77577757
*/
77587758
inline
77597759
bool block_ptr_array_range(bm::word_t** arr, unsigned& left, unsigned& right)

src/bmserial.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ class operation_deserializer
631631
typedef BV bvector_type;
632632
typedef typename bvector_type::size_type size_type;
633633
public:
634-
/**
634+
/*!
635635
\brief Deserialize bvector using buffer as set operation argument
636636
637637
\param bv - target bvector

src/bmsparsevec.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ class sparse_vector : public base_sparse_vector<Val, BV, 1>
539539
/*!
540540
\brief Import list of elements from a C-style array (pushed back)
541541
\param arr - source array
542-
\param srr_size - source size
542+
\param arr_size - source array size
543543
\param set_not_null - import should register in not null vector
544544
*/
545545
void import_back(const value_type* arr,
@@ -784,8 +784,8 @@ class sparse_vector : public base_sparse_vector<Val, BV, 1>
784784
\param size - dest size
785785
\param offset - target index in the sparse vector to export from
786786
\param zero_mem - set to false if target array is pre-initialized
787-
with 0s to avoid performance penalty
788-
787+
with 0s to avoid performance penalty
788+
\param pool_ptr - optional pointer to block allocation pool
789789
\return number of exported elements
790790
791791
\sa decode

src/bmsparsevec_serial.h

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,6 @@ class sparse_vector_serializer
173173
174174
\param sv - sparse vector to serialize
175175
\param sv_layout - buffer structure to keep the result
176-
\param temp_block - temporary buffer
177-
(allocate with BM_DECLARE_TEMP_BLOCK(x) for speed)
178-
\param bv_serialization_flags - bit-vector serialization flags
179176
as defined in bm::serialization_flags
180177
*/
181178
void serialize(const SV& sv,
@@ -327,7 +324,7 @@ Serialization format:
327324
328325
ADDRESS_BITVECTROR:
329326
INT64: address bit-vector size
330-
<memblock>: serialized address bit-vector
327+
[memblock]: serialized address bit-vector
331328
332329
LIST_OF_BUFFER_SIZES:
333330
INT64 - buffer sizes count
@@ -336,8 +333,8 @@ Serialization format:
336333
...
337334
338335
BUFFERS:
339-
<memblock>: block0
340-
<memblock>: block1
336+
[memblock]: block0
337+
[memblock]: block1
341338
...
342339
343340
</pre>

0 commit comments

Comments
 (0)