add general render_javadoc function

Author: MrMaydo

src/header_generator.py

@@ -1,7 +1,7 @@
 import re
-from typing import List
+from typing import List, Union
 
-from java_model import Field
+from src.java_model import Field, indent
 
 
 def set_package(package: str) -> str:
@@ -20,6 +20,18 @@ def set_imports(fields: List[Field]) -> str:
     return "\n".join(imports)
 
 
+def render_javadoc(description: Union[str, None], indent_lvl: int) -> str:
+    if description is None or description == "":
+        return ""
+
+    return "\n".join([
+        "",
+        f"{indent(indent_lvl)}/**",
+        f"{indent(indent_lvl)} * {description}",
+        f"{indent(indent_lvl)} */"
+    ])
+
+
 _imports = {
     "Date": "import java.util.Date;",
     "List": "import java.util.List;",

tests/test_header_generator.py

@@ -1,7 +1,7 @@
 import pytest
 
-from java_model import Field
-from src.header_generator import set_package, set_imports
+from src.java_model import Field
+from src.header_generator import set_package, set_imports, render_javadoc
 
 
 def test_set_package():
@@ -55,3 +55,27 @@ def test_set_imports_no_additional_imports():
     expected = """\
 import java.util.Objects;"""
     assert set_imports(fields) == expected
+
+
+def test_render_javadoc_class_indent():
+    description = "Example class description"
+    expected = """
+/**
+ * Example class description
+ */"""
+    assert render_javadoc(description, 0) == expected
+
+
+def test_render_javadoc_field_indent():
+    description = "Example field description"
+    expected = """
+    /**
+     * Example field description
+     */"""
+    assert render_javadoc(description, 1) == expected
+
+
+def test_render_javadoc_no_description():
+    assert render_javadoc("", 0) == ""
+    assert render_javadoc(None, 0) == ""
+    assert render_javadoc(None, 1) == ""