ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

avoid duplicate code comments

Browse Source 
when a function is decribed in hist.h,
do not describe it again in hist.c
to avoid future doc synchronization issues.
This commit is contained in:
Yann Collet
2018-06-14 19:47:05 -04:00
parent 78e5e2887e
commit 6901c94cd6
2 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/compress/hist.h
+5 -3
View File
@@ -81,10 +81,12 @@ size_t HIST_countFast_wksp(unsigned* count, unsigned* maxSymbolValuePtr,
unsigned* workSpace);
/*! HIST_count_simple() :
* Same as HIST_countFast(), but does not use any additional memory (not even on stack).
* This function is unsafe, and will segfault if any value within `src` is `> *maxSymbolValuePtr`.
* Same as HIST_countFast(), this function is unsafe,
* and will segfault if any value within `src` is `> *maxSymbolValuePtr`.
* It is also a bit slower for large inputs.
* This function doesn't produce any error (i.e. it must succeed).
* However, it does not need any additional memory (not even on stack).
* @return : count of the most frequent symbol.
* Note this function doesn't produce any error (i.e. it must succeed).
*/
unsigned HIST_count_simple(unsigned* count, unsigned* maxSymbolValuePtr,
const void* src, size_t srcSize);