Missing documentation
Opened this issue · 2 comments
albert-github commented
Documentation
In the file https://github.com/boostorg/sort/blob/develop/include/boost/sort/common/merge_block.hpp I see around the line 175
//-------------------------------------------------------------------------
// function :
/// @brief
/// @param
/// @return
//-------------------------------------------------------------------------
void merge_range_pos(it_index itx_first, it_index itx_mid,
it_index itx_last);
- missing information for the end user about the usage of the function
- this will give problems with documentation generators due to missing information / incorrect information
For some other functions the documentation is also missing / incomplete whilst for a number of functions documentation is present.
I didn't check other files.
Edit just saw similar problems in https://github.com/boostorg/sort/blob/develop/include/boost/sort/flat_stable_sort/flat_stable_sort.hpp (e.g. line 107, 134).
fjtapia commented
Yes
I saw yesterday. I will fill.
Thanks
El vie, 12 mar 2021 a las 1:27, spreadsort ***@***.***>)
escribió:
… Assigned #51 <#51> to @fjtapia
<https://github.com/fjtapia>.
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub
<#51 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA5O5GB4ZMUE5JKCGWYLLDTTDFGULANCNFSM4ZAWWU3Q>
.
nigels-com commented
merge_block.hpp line 176
//-------------------------------------------------------------------------
// function :
/// @brief
/// @param
/// @return
//-------------------------------------------------------------------------
void merge_range_pos(it_index itx_first, it_index itx_mid,
it_index itx_last);
merge_block.hpp line 216
//-------------------------------------------------------------------------
// function :
/// @brief
/// @param
/// @return
//-------------------------------------------------------------------------
template<class Iter_t, class Compare, uint32_t Power2>
void merge_block<Iter_t, Compare, Power2>
::merge_range_pos(it_index itx_first, it_index itx_mid,it_index itx_last)
{
...