Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pdimov committed Jul 16, 2024
1 parent 07d833f commit fb66e1e
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 28 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ by Howard Hinnant, Vinnie Falco and John Bytheway.
It also contains implementations of several popular hashing algorithms:

* [FNV-1a](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function)
* [MurmurHash 3](https://github.com/aappleby/smhasher/wiki/MurmurHash3)
* [xxHash](https://cyan4973.github.io/xxHash/)
* [SpookyHash v2](http://burtleburtle.net/bob/hash/spooky.html)
* [SipHash](https://131002.net/siphash/)
* [MD5](https://tools.ietf.org/html/rfc1321)
* [SHA-1](https://tools.ietf.org/html/rfc3174)
Expand Down
2 changes: 1 addition & 1 deletion doc/hash2/copyright.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ https://www.boost.org/LICENSE_1_0.txt
# Copyright and License
:idprefix:

This documentation is copyright 2020 Peter Dimov and is distributed under
This documentation is copyright 2020, 2024 Peter Dimov and is distributed under
the http://www.boost.org/LICENSE_1_0.txt[Boost Software License, Version 1.0].
14 changes: 8 additions & 6 deletions doc/hash2/implementation.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
////
Copyright 2020 Peter Dimov
Copyright 2020, 2024 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
https://www.boost.org/LICENSE_1_0.txt
////
Expand All @@ -10,9 +10,11 @@ https://www.boost.org/LICENSE_1_0.txt

## Supported Compilers

* g++ 4.4 or later
* clang++ 3.3 or later
* Visual Studio 2008 and above
The library requires {cpp}11. The following compilers:

Tested on https://travis-ci.org/github/pdimov/hash2[Travis] and
https://ci.appveyor.com/project/pdimov/hash2[Appveyor].
* g++ 4.8 or later
* clang++ 3.9 or later
* Visual Studio 2015 and above
are being tested on https://github.com/pdimov/hash2/actions/[Github Actions]
and https://ci.appveyor.com/project/pdimov/hash2/[Appveyor].
2 changes: 0 additions & 2 deletions doc/hash2/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ that weren't yet available at the time the type was defined.
The following popular hashing algorithms are provided:

* https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function[FNV-1a]
* https://github.com/aappleby/smhasher/wiki/MurmurHash3[MurmurHash 3]
* https://cyan4973.github.io/xxHash/[xxHash]
* http://burtleburtle.net/bob/hash/spooky.html[SpookyHash v2]
* https://131002.net/siphash/[SipHash]
* https://tools.ietf.org/html/rfc1321[MD5]
* https://tools.ietf.org/html/rfc3174[SHA-1]
Expand Down
18 changes: 1 addition & 17 deletions doc/hash2/reference.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
////
Copyright 2020 Peter Dimov
Copyright 2020, 2024 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
https://www.boost.org/LICENSE_1_0.txt
////
Expand All @@ -12,12 +12,8 @@ https://www.boost.org/LICENSE_1_0.txt

### <boost/hash2/fnv1a.hpp>

### <boost/hash2/murmur3.hpp>

### <boost/hash2/xxhash.hpp>

### <boost/hash2/spooky2.hpp>

### <boost/hash2/siphash.hpp>

### <boost/hash2/hmac.hpp>
Expand All @@ -30,20 +26,8 @@ https://www.boost.org/LICENSE_1_0.txt

### <boost/hash2/endian.hpp>

### <boost/hash2/is_range.hpp>

### <boost/hash2/is_contiguous_range.hpp>

### <boost/hash2/is_unordered_range.hpp>

### <boost/hash2/is_uniquely_represented.hpp>

### <boost/hash2/is_contiguously_hashable.hpp>

### <boost/hash2/is_tuple_like.hpp>

### <boost/hash2/underlying_type.hpp>

### <boost/hash2/get_integral_result.hpp>

## hash_append
Expand Down

0 comments on commit fb66e1e

Please sign in to comment.