add links in stdlib_hashmaps

Author: jvdp1

src/stdlib_hashmaps.f90

@@ -70,6 +70,7 @@ module stdlib_hashmaps
 !! Version: Experimental
 !!
 !! Type implementing an abstract hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-hashmap_type-abstract-type))
         private
         integer(int_calls) :: call_count = 0
 !! Number of calls
@@ -158,6 +159,8 @@ subroutine key_test(map, key, present)
 !! Version: Experimental
 !!
 !! Returns a logical flag indicating whether KEY exists in the hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#key_test-indicates-whether-key-is-present))
+!!
 !! Arguments:
 !!     map     - the hash map of interest
 !!     key     - the key of interest
@@ -173,6 +176,8 @@ pure function loading( map )
 !! Version: Experimental
 !!
 !! Returns the number of entries relative to slots in a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#loading-returns-the-ratio-of-entries-to-slots))
+!!
 !! Arguments:
 !!       map - a hash map
             import hashmap_type
@@ -184,8 +189,8 @@ subroutine map_entry(map, key, other, conflict)
 !! Version: Experimental
 !!
 !! Inserts an entry into the hash table
-!!  Arguments:
-!
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#map_entry-inserts-an-entry-into-the-hash-map))
+!!
             import hashmap_type, key_type, other_type
             class(hashmap_type), intent(inout)     :: map
             type(key_type), intent(in)             :: key
@@ -246,6 +251,7 @@ function total_depth( map )
 !!
 !! Returns the total number of ones based offsets of slot entriesyy from
 !! their slot index for a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#total_depth-returns-the-total-depth-of-the-hash-map-entries))
 !! Arguments:
 !!     map - a hash map
             import hashmap_type, int64
@@ -261,6 +267,7 @@ end function total_depth
 !! Version: Experimental
 !!
 !! Chaining hash map entry type
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-chaining_map_entry_type-derived-type))
         private
         integer(int_hash)  :: hash_val
 !! Full hash value
@@ -279,6 +286,7 @@ end function total_depth
 !! Version: Experimental
 !!
 !! Wrapper for a pointer to a chaining map entry type object
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-chaining_map_entry_type_ptr-derived-type))
         type(chaining_map_entry_type), pointer :: target => null()
     end type chaining_map_entry_ptr
 
@@ -287,6 +295,7 @@ end function total_depth
 !! Version: Experimental
 !!
 !! Type implementing a pool of allocated `chaining_map_entry_type`
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-chaining_map_entry_pool-derived-type))
         private
 ! Index of next bucket
         integer(int_index)                         :: next = 0
@@ -299,6 +308,7 @@ end function total_depth
 !! Version: Experimental
 !!
 !! Type implementing the `chaining_hashmap_type` types
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-chaining_hashmap_type-derived-type))
         private
         type(chaining_map_entry_pool), pointer    :: cache => null()
 !! Pool of allocated chaining_map_entry_type objects
@@ -487,6 +497,7 @@ end function total_chaining_depth
 !! Version: Experimental
 !!
 !! Open hash map entry type
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-open_map_entry_type-derived-type))
         private
         integer(int_hash) :: hash_val
 !! Full hash value
@@ -512,6 +523,7 @@ end function total_chaining_depth
 !! Version: Experimental
 !!
 !! Wrapper for a pointer to an open hash map entry type object
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#the-open_map_entry_ptr-derived-type))
         type(open_map_entry_type), pointer :: target => null()
     end type open_map_entry_ptr
 
@@ -720,6 +732,8 @@ pure function calls( map )
 !! Version: Experimental
 !!
 !! Returns the number of subroutine calls on an open hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#calls-returns-the-number-of-calls-on-the-hash-map))
+!!
 !! Arguments:
 !!     map - an open hash map
         class(hashmap_type), intent(in) :: map
@@ -733,6 +747,8 @@ pure function entries( map )
 !! Version: Experimental
 !!
 !! Returns the number of entries in a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#entries-returns-the-number-of-entries-in-the-hash-map))
+!!
 !! Arguments:
 !!     map - an open hash map
         class(hashmap_type), intent(in) :: map
@@ -747,6 +763,8 @@ pure function map_probes( map )
 !! Version: Experimental
 !!
 !! Returns the total number of table probes on a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#map_probes-returns-the-number-of-hash-map-probes))
+!!
 !! Arguments:
 !!     map - an open hash map
         class(hashmap_type), intent(in) :: map
@@ -761,6 +779,8 @@ pure function num_slots( map )
 !! Version: Experimental
 !!
 !! Returns the number of allocated slots in a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#num_slots-returns-the-number-of-hash-map-slots))
+!!
 !! Arguments:
 !!     map - an open hash map
         class(hashmap_type), intent(in) :: map
@@ -776,6 +796,8 @@ pure function slots_bits( map )
 !!
 !! Returns the number of bits used to specify the number of allocated
 !! slots in a hash map
+!! ([Specifications](../page/specs/stdlib_hashmaps.html#slots_bits-returns-the-number-of-bits-used-to-address-the-hash-map-slots))
+!!
 !! Arguments:
 !!     map - an open hash map
         class(hashmap_type), intent(in) :: map