summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2017-07-13 21:19:59 (GMT)
committerTobias Markmann <tm@ayena.de>2017-07-13 21:25:27 (GMT)
commitfdf808cde2f3004aa61cba3bb60cb60a46665e4e (patch)
tree7b4d4c910158a9c3501e92e393d08910d30409c7
parent497dfb8ab128b0bbfdb6b3045caa03f8b38bc9fc (diff)
downloadswift-fdf808cde2f3004aa61cba3bb60cb60a46665e4e.zip
swift-fdf808cde2f3004aa61cba3bb60cb60a46665e4e.tar.bz2
Fix LRUCache documentation
Doxygen raised warnings for referencing unknown classes and template variables it cannot deal with. Adjusted the comment to just format them instead of referencing. Test-Information: Ran ./scons doc=1 and verified that doxygen did not raise warnings anymore. Change-Id: I8927195457bbaf92066591f24e536e9b48a04808
-rw-r--r--Swiften/Base/LRUCache.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/Swiften/Base/LRUCache.h b/Swiften/Base/LRUCache.h
index e4e652f..1f92612 100644
--- a/Swiften/Base/LRUCache.h
+++ b/Swiften/Base/LRUCache.h
@@ -19,9 +19,9 @@ namespace Swift {
/**
- * The \ref LRUCache templaged class implements a lookup cache which removes
+ * The \ref LRUCache template class implements a lookup cache which removes
* the least recently used cached item from the cache, if the cache size hits
- * the \ref MAX_SIZE limit.
+ * the \p MAX_SIZE limit.
*
* An example use is a cache for entity capabilities hash to DiscoInfo.
*/
@@ -32,9 +32,9 @@ public:
public:
/**
- * Inserts the key/value pair in the front of the cache. If the \ref key
+ * Inserts the key/value pair in the front of the cache. If the \p key
* already exists in the cache, it is moved to the front instead. If
- * afterwards, the cahe size exceeds the \ref MAX_SIZE limit, the least
+ * afterwards, the cahe size exceeds the \p MAX_SIZE limit, the least
* recently item is removed from the cache.
*/
void insert(const KEY_TYPE& key, VALUE_TYPE value) {
@@ -48,11 +48,11 @@ public:
}
/**
- * Looks up a cache entry based on the provided \ref key and moves it back
+ * Looks up a cache entry based on the provided \p key and moves it back
* to the front of the cache. If there is no cache entry for the provided
- * \ref key, an uninitialized \ref boost::optional is returned.
- * If the optional \ref missFunction is provided, it is called on a cache miss.
- * If the \ref missFunction returns an initialized \ref boost::optional, the
+ * \p key, an uninitialized \p boost::optional is returned.
+ * If the optional \p missFunction is provided, it is called on a cache miss.
+ * If the \p missFunction returns an initialized \p boost::optional, the
* value is inserted in the cache.
*/
boost::optional<VALUE_TYPE> get(const KEY_TYPE& key, cacheMissFunction missFunction = cacheMissFunction()) {