From f3231b38b6c9f15ea726bdeef512094e3e604919 Mon Sep 17 00:00:00 2001
From: Michael Zillgith <michael.zillgith@mz-automation.de>
Date: Tue, 1 Oct 2024 06:55:37 +0100
Subject: [PATCH] - added documentation for function
 MmsVariableSpecification_getStructureElements

---
 src/mms/inc/mms_type_spec.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/mms/inc/mms_type_spec.h b/src/mms/inc/mms_type_spec.h
index 2dec2bf5..091fe1f2 100644
--- a/src/mms/inc/mms_type_spec.h
+++ b/src/mms/inc/mms_type_spec.h
@@ -116,6 +116,16 @@ MmsVariableSpecification_isValueOfType(MmsVariableSpecification* self, const Mms
 LIB61850_API const char*
 MmsVariableSpecification_getName(MmsVariableSpecification* self);
 
+/**
+ * \brief Returns a list of the structure element names in case the instance is of type MMS_STRUCTURE
+ *
+ * \note the caller is the owner of the returned list and its elements. They can be released with \ref LinkedList_destroy
+ *
+ * \param self the MmsVariableSpecification instance
+ *
+ * \returns a LinkedList of strings that represent the structure element names. Elements are null terminated string.
+ *          If the MmsVariableSpecification instance is not of type MMS_STRUCTURE the function returns NULL.
+ */
 LIB61850_API LinkedList /* <char*> */
 MmsVariableSpecification_getStructureElements(MmsVariableSpecification* self);