From 5a04ba84164070855c26737640f41ed3cb6dcf11 Mon Sep 17 00:00:00 2001 From: Michael Vogel Date: Sun, 20 Mar 2016 16:16:15 +0100 Subject: [PATCH] Added documentation --- include/xml.php | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/include/xml.php b/include/xml.php index c74c23c473..2aed3fe8ed 100644 --- a/include/xml.php +++ b/include/xml.php @@ -4,6 +4,16 @@ * */ class xml { + /** + * @brief Creates an XML structure out of a given array + * + * @param array $array The array of the XML structure that will be generated + * @param object $xml The createdXML will be returned by reference + * @param bool $remove_header Should the XML header be removed or not? + * @param array $namespaces List of namespaces + * + * @return string The created XML + */ function from_array($array, &$xml, $remove_header = false, $namespaces = array(), $root = true) { if ($root) { @@ -60,6 +70,13 @@ class xml { } } + /** + * @brief Copies an XML object + * + * @param object $source The XML source + * @param object $target The XML target + * @param string $elementname Name of the XML element of the target + */ function copy(&$source, &$target, $elementname) { if (count($source->children()) == 0) $target->addChild($elementname, xmlify($source)); -- 2.39.5