feat: add function in namespace snippet

Author: barnou-psee

docs/snippets/functions.md

@@ -31,3 +31,39 @@ indent_level: 4
 ::: doxy.animal.function
 name: mEin
 indent_level: 4
+
+## `::: doxy.<project>.namespace.function`
+
+This tag generates full function documentation.
+
+| Parameter | Description               | Required |
+|-----------|---------------------------|----------|
+| `name`    | The name of the function. | Yes      |
+
+
+=== "Tag usage"
+    ```yaml
+    ::: doxy.animal.namespace.function
+        namespace: example
+        name: void some_namespace_function(Animal* animal)
+    ```
+=== "Tag result"
+::: doxy.animal.namespace.function
+namespace: example
+name: void some_namespace_function(Animal* animal)
+indent_level: 4
+
+
+## `::: doxy.<project>.function` error message
+
+=== "Tag usage"
+    ```yaml
+    ::: doxy.animal.namespace.function
+        namespace: example
+        name: void no_function()
+    ```
+=== "Tag result"
+::: doxy.animal.function
+namespace: example
+name: void no_function()
+indent_level: 4

mkdoxy/finder.py

@@ -25,6 +25,15 @@ def doxyClass(self, project, className: str):
             return self.listToNames(classes)
         return None
 
+    def doxyNamespace(self, project, namespace: str):
+        namespaces = recursive_find(self.doxygen[project].root.children, Kind.NAMESPACE)
+        if namespaces:
+            for findNamespace in namespaces:
+                if findNamespace.name_long == namespace:
+                    return findNamespace
+            return self.listToNames(namespaces)
+        return None
+
     def doxyClassMethod(self, project, className: str, methodName: str):
         findClass = self.doxyClass(project, className)
         if findClass:
@@ -43,6 +52,24 @@ def doxyClassMethod(self, project, className: str, methodName: str):
                 return None
         return None
 
+    def doxyNamespaceFunction(self, project, namespace: str, functionName: str):
+        findNamespace = self.doxyNamespace(project, namespace)
+        if findNamespace:
+            if isinstance(findNamespace, list):
+                for member in findNamespace:
+                    if self._normalize(functionName) in self._normalize(member):
+                        return member
+                return findNamespace
+            else:
+                members = recursive_find(findNamespace.children, Kind.FUNCTION)
+                if members:
+                    for member in members:
+                        if self._normalize(functionName) in self._normalize(member.name_params):
+                            return member
+                    return self.listToNames(members)
+                return None
+        return None
+
     def doxyFunction(self, project, functionName: str):
         functions = recursive_find_with_parent(self.doxygen[project].files.children, [Kind.FUNCTION], [Kind.FILE])
         if functions:

mkdoxy/generatorSnippets.py

@@ -42,6 +42,7 @@ def __init__(
         self.doxy_arguments = {
             "code": self.doxyCode,
             "function": self.doxyFunction,
+            "namespace.function": self.doxyNamespaceFunction,
             "class": self.doxyClass,
             "class.method": self.doxyClassMethod,
             "class.list": self.doxyClassList,
@@ -370,6 +371,29 @@ def doxyNamespaceList(self, snippet, project: str, config):
         self._setLinkPrefixNodes(nodes, self.pageUrlPrefix + project + "/")
         return self.generatorBase[project].namespaces(nodes, config)
 
+    def doxyNamespaceFunction(self, snippet, project: str, config):
+        errorMsg = self.checkConfig(snippet, project, config, ["namespace", "name"])
+        if errorMsg:
+            return errorMsg
+
+        node = self.finder.doxyNamespaceFunction(project, config.get("namespace"), config.get("name"))
+        if node is None:
+            return self.doxyNodeIsNone(project, config, snippet)
+
+        if isinstance(node, Node):
+            self._setLinkPrefixNode(node, self.pageUrlPrefix + project + "/")
+            return self.generatorBase[project].function(node, config)
+        return self.doxyError(
+            project,
+            config,
+            "Incorrect namespace function configuration",
+            f"Did not find Class with name: `{config.get('name')}` and method: `{config.get('method')}`",
+            "Available classes and methods:",
+            "\n".join(node),
+            "yaml",
+            snippet,
+        )
+
     def doxyFileList(self, snippet, project: str, config):
         errorMsg = self.checkConfig(snippet, project, config, [])
         if errorMsg: