Skip to content

Commit fa71f36

Browse files
committed
add links in stdlib_hashmap_wrappers.f90
1 parent dd120fe commit fa71f36

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

src/stdlib_hashmap_wrappers.f90

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,9 @@ end function hasher_fun
110110
pure subroutine copy_key( old_key, new_key )
111111
!! Version: Experimental
112112
!!
113-
!! Copies the contents of the key, old_key, to the key, out_key
113+
!! Copies the contents of the key, old_key, to the key, new_key
114+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#copy_key-returns-a-copy-of-the-key))
115+
!!
114116
!! Arguments:
115117
!! old_key - the input key
116118
!! new_key - the output copy of old_key
@@ -126,6 +128,8 @@ subroutine copy_other( other_in, other_out )
126128
!! Version: Experimental
127129
!!
128130
!! Copies the other data, other_in, to the variable, other_out
131+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#copy_other-returns-a-copy-of-the-other-data))
132+
!!
129133
!! Arguments:
130134
!! other_in - the input data
131135
!! other_out - the output data
@@ -141,6 +145,8 @@ function equal_keys( key1, key2 ) result(test) ! Chase's tester
141145
!! Version: Experimental
142146
!!
143147
!! Compares two keys for equality
148+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#operator(==)-compares-two-keys-for-equality))
149+
!!
144150
!! Arguments:
145151
!! key1 - the first key
146152
!! key2 - the second key
@@ -167,6 +173,8 @@ subroutine free_key( key )
167173
!! Version: Experimental
168174
!!
169175
!! Frees the memory in a key
176+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#free_key-frees-the-memory-associated-with-a-key))
177+
!!
170178
!! Arguments:
171179
!! key - the key
172180
type(key_type), intent(inout) :: key
@@ -180,6 +188,8 @@ subroutine free_other( other )
180188
!! Version: Experimental
181189
!!
182190
!! Frees the memory in the other data
191+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#free_other-frees-the-memory-associated-with-other-data))
192+
!!
183193
!! Arguments:
184194
!! other - the other data
185195
type(other_type), intent(inout) :: other
@@ -330,6 +340,8 @@ pure function fnv_1a_hasher( key )
330340
!! Version: Experimental
331341
!!
332342
!! Hashes a key with the FNV_1a algorithm
343+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#fnv_1a_hasher-calculates-a-hash-code-from-a-key))
344+
!!
333345
!! Arguments:
334346
!! key - the key to be hashed
335347
type(key_type), intent(in) :: key
@@ -344,6 +356,8 @@ pure function seeded_nmhash32_hasher( key )
344356
!! Version: Experimental
345357
!!
346358
!! Hashes a key with the NMHASH32 hash algorithm
359+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#seeded_nmhash32_hasher-calculates-a-hash-code-from-a-key))
360+
!!
347361
!! Arguments:
348362
!! key - the key to be hashed
349363
!! seed - the seed (unused) for the hashing algorithm
@@ -360,6 +374,7 @@ pure function seeded_nmhash32x_hasher( key )
360374
!! Version: Experimental
361375
!!
362376
!! Hashes a key with the NMHASH32X hash algorithm
377+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#seeded_nmhash32x_hasher-calculates-a-hash-code-from-a-key))
363378
!! Arguments:
364379
!! key - the key to be hashed
365380
!! seed - the seed (unused) for the hashing algorithm
@@ -376,6 +391,8 @@ pure function seeded_water_hasher( key )
376391
!! Version: Experimental
377392
!!
378393
!! Hashes a key with the waterhash algorithm
394+
!! ([Specifications](../page/specs/stdlib_hashmaps.html#seeded_water_hasher-calculates-a-hash-code-from-a-key))
395+
!!
379396
!! Arguments:
380397
!! key - the key to be hashed
381398
type(key_type), intent(in) :: key

0 commit comments

Comments
 (0)