boostorg / boostorg/sort

Missing documentation

Open
#51 2 comments 0 reactions 1 assignee Claimed by @fjtapia View on GitHub
Dominant language
C++
Stars
58
Forks
47
PR merge metrics
No merged PRs in 30d

Description

## 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).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.