Skip to content

Instantly share code, notes, and snippets.

@celeron55
Created December 15, 2014 10:39
Show Gist options
  • Save celeron55/2795fefc8b2ac3592efb to your computer and use it in GitHub Desktop.
Save celeron55/2795fefc8b2ac3592efb to your computer and use it in GitHub Desktop.
diff --git a/src/itemdef.h b/src/itemdef.h
index 11d5664..a04f9b7 100644
--- a/src/itemdef.h
+++ b/src/itemdef.h
@@ -115,9 +115,9 @@ struct ItemDefinition
*
* getInventoryTexture() and getWieldMesh() act differently depending on
* if called from the main thread or called from another thread.
- * If called from another thread, it will queue up a job to get the
- * inventory texture and wield mesh and wait up to 1 second for it to finish.
- * See CItemDefManager::processQueue and CItemDefManager::getClientCached.
+ * If called from another thread, it queues up a job to get the inventory
+ * texture and wield mesh and wait up to 1 second for it to finish. See
+ * CItemDefManager::processQueue and CItemDefManager::getClientCached.
*
* Every job is cached (including the main thread jobs), so subsequent calls
* will just read from the cache.
@@ -125,22 +125,28 @@ struct ItemDefinition
* cached result from the actual name. Adding aliases or item definitions will
* not clear the cache.
*
- * getAll() will return all names and aliases.
+ * getAll() returns all names and aliases.
*
- * get() will return the "unknown" item if the requested item isn't found.
+ * get() returns the "unknown" item if the requested item isn't found.
*
- * registerItem() will overwrite any existing item with the same name and will
+ * registerItem() overwrites any existing item with the same name and will
* remove an alias if it is equal to the new item's name.
*
* registerAlias() will not overwrite an existing alias if it already exists.
*
- * clear() will remove all registered items and aliases. It will re-add the
- * built-in items, which are: hand, unknown, air, and ignore.
+ * clear() removes all registered items and aliases. It re-adds the built-in
+ * items, which are: hand, unknown, air, and ignore.
*
- * processQueue() will handle the job requests from getInventoryTexture() and
+ * processQueue() handles the job requests from getInventoryTexture() and
* getWieldMesh(). It should only be run from the main thread.
*/
+/**
+ * @class IItemDefManager
+ *
+ * See CItemDefManager
+ */
+
class IItemDefManager
{
public:
@@ -161,6 +167,12 @@ class IItemDefManager
virtual void serialize(std::ostream &os, u16 protocol_version)=0;
};
+/**
+ * @class IWritableItemDefManager
+ *
+ * See CItemDefManager
+ */
+
class IWritableItemDefManager : public IItemDefManager
{
public:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment