[wip]

doc/doxygen/index.md

-radle is a parser for resource description files.
+# radle
+
+A resource description language (RDL) file for Maestro is a
+
+The user facing interface for radle consists of the following data types and functions:
+
+
+
+The structure of [inventory](#inventory) [radle inventory](@ref radle_inventory)
+
+<a name="inventory"></a>
+# Inventory

src/include/radle/inventory.h

@@ -19,9 +19,22 @@ typedef struct {
   radle_resource** resource_ptr_array;
 } radle_inventory;
 
-/// Initialize Inventory to A Sane State
+/// Initialize radle_inventory to an empty state
+///
+/// @param inventory_ptr Pointer to the inventory to be initialized
+///
+/// This function
+/// - sets `inventory_ptr->nresource=0`
+/// - sets `inventory_ptr->resource_ptr_array=NULL`
+///
+/// Note: This function should only be used to initialize an uninitialized
+/// radle_inventory object. This function does not destruct the previous
+/// object pointed to by the `resource_ptr_array`, and hence, using them on
+/// already initialized `radle_inventory` will lead to memory leaks.
 void radle_initialize_inventory(radle_inventory* inventory_ptr);
 
-/// Delete the Inventory Correctly
+/// Delete the Contents of the Inventory
+/// @param inventory_ptr Pointer to the inventory whose contents are to be
+/// deleted.
 void radle_delete_inventory(radle_inventory* inventory_ptr);
 #endif // RADLE_INVENTORY_H