diff --git a/cmake/configure/doxyfile.in b/cmake/configure/doxyfile.in index a6aa8f008e44c4eace58bda8b487650c3a5ccbb7..d3bf736097ab9750c544d5adee6c0368ce9f7285 100644 --- a/cmake/configure/doxyfile.in +++ b/cmake/configure/doxyfile.in @@ -10,7 +10,7 @@ FILE_PATTERNS = *.h RECURSIVE = YES QUIET = YES USE_MDFILE_AS_MAINPAGE = @doxy_main_page@ -EXTRACT_ALL = YES +EXTRACT_ALL = YES EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES TEMPLATE_RELATIONS = YES diff --git a/doc/doxygen/index.md b/doc/doxygen/index.md index 3e6f3d18a6298dd5aa10e557b87a228feefe19a2..7e76ed2660a92935d3f6197cfed242d28e0da4a5 100644 --- a/doc/doxygen/index.md +++ b/doc/doxygen/index.md @@ -1 +1,12 @@ -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 diff --git a/src/include/radle/inventory.h b/src/include/radle/inventory.h index 5a84a2f56a088e1ea1d66037047d582a24906bd1..4b790f897bf0d5d086db815d20a84c1d4f4d1b21 100644 --- a/src/include/radle/inventory.h +++ b/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