Fix documentation generation for custom keys (#34)

* Fix missing include in doc generation * Fix doc link in README
coveooss · Feb 20, 2023 · 02ff6b3 · 02ff6b3
1 parent 22f0084
commit 02ff6b3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = README.md implementingCustomPolicies.dox heterogeneousLookup.dox include/
+INPUT                  = README.md implementingCustomPolicies.dox usingCustomKeys.dox heterogeneousLookup.dox include/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ as well as a comprehensive set of primitives for building custom caching solutio
 #### Custom Keys
 
 Cachemere supports using arbitrary types as keys. The page
-on [Using Custom Keys](https://coveooss.github.io/cachemere/usingCustomKeys.html) covers this in greater detail.
+on [Using Custom Keys](https://coveooss.github.io/cachemere/customKeys.html) covers this in greater detail.
 
 #### Heterogeneous Lookup
 
@@ -108,4 +108,4 @@ policies can also be used with different cache implementations.
 For instance, instead of using more common policies like Least-Recently Used (LRU),
 a product might need to use a custom cache that takes the frequency of access as well as the size of the item into
 consideration when establishing which item to evict. To do this, one could implement a `SizeBasedEvictionPolicy` and use
-it with the existing `cachemere::Cache`.
+it with the existing `cachemere::Cache`.