Improve API docs#45
Draft
dalloriam wants to merge 3 commits into
Draft
Conversation
dalloriam
force-pushed
the
doc/api-docs-0.4
branch
from
May 27, 2026 18:37
25cf0cc to
79f7477
Compare
There was a problem hiding this comment.
Pull request overview
This PR improves public API documentation for cache concepts, policies, presets, measurement helpers, locking strategies, and custom policy implementation guidance. It also promotes reusable concepts into a new public cachemere/concepts.h header and updates policy/cache templates to use it.
Changes:
- Added
include/cachemere/concepts.hand exported/included it through the umbrella header and CMake sources. - Updated template constraints to use public concepts instead of
detail::traits. - Expanded Doxygen comments for presets, cache results, policy tickets, constraints, measurement utilities, composite keys, and custom policy docs.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
CMakeLists.txt |
Adds the new public concepts header to interface sources. |
include/cachemere.h |
Exposes cachemere/concepts.h via the umbrella include. |
include/cachemere/cache.h |
Uses public concepts and improves API documentation. |
include/cachemere/concepts.h |
Introduces public cache-related concepts. |
include/cachemere/composite_key.h |
Adds documentation for composite key construction, comparison, and hashing. |
include/cachemere/detail/locking.h |
Expands LockingStrategy documentation. |
include/cachemere/detail/traits.h |
Removes concepts that are now public while retaining internal traits. |
include/cachemere/measurement.h |
Documents measurement helpers and pointer handling. |
include/cachemere/policy/constraint_count.h |
Uses public concepts and documents tickets/constraint methods. |
include/cachemere/policy/constraint_memory.h |
Uses public concepts and documents tickets/constraint methods. |
include/cachemere/policy/detail/hash_mixer.h |
Uses the public hasher concept. |
include/cachemere/policy/eviction_gdsf.h |
Uses public concepts and documents eviction tickets/rollback behavior. |
include/cachemere/policy/eviction_lru.h |
Uses public concepts and documents eviction tickets/rollback behavior. |
include/cachemere/policy/eviction_segmented_lru.h |
Uses public concepts and documents eviction tickets/rollback behavior. |
include/cachemere/policy/insertion_always.h |
Uses public concepts. |
include/cachemere/policy/insertion_tinylfu.h |
Uses public concepts. |
include/cachemere/presets.h |
Adds documentation for preset alias templates. |
implementingCustomPolicies.dox |
Updates custom policy documentation to match the current policy interfaces. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.