From fc1b6eec954a35d46df46bd8741ad5e17422a34d Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Tue, 15 Apr 2025 15:35:46 +0200
Subject: [PATCH] Fix model_maker inline documentation
---
src/scripts/model_maker.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/scripts/model_maker.py b/src/scripts/model_maker.py
index 6e2d3d5..7d3eeb5 100755
--- a/src/scripts/model_maker.py
+++ b/src/scripts/model_maker.py
@@ -31,6 +31,7 @@ import pdb
import random
import yaml
+## \brief 3D software generation capability flag.
allow_3d = True
try:
import pyvista as pv
@@ -46,7 +47,7 @@ from sys import argv
# `main()` is the function that handles the creation of the code configuration.
# It returns an integer value as exit code, using 0 to signal successful execution.
#
-# \returns result: `int` Number of detected error-level inconsistencies.
+# \returns result: `int` Exit code (0 = SUCCESS).
def main():
result = 0
config = parse_arguments()
@@ -952,9 +953,10 @@ def write_legacy_sconf(conf):
## \brief Export the model to a set of OBJ files for 3D visualization.
#
-# This function exports the model as a set of OBJ files (one for every
-# spherical unit, plus a single scene file) to allow for model visualization
-# with 3D software tools.
+# This function exports the model as a single OBJ file, containing the
+# information to visualize the particle with 3D software tools. The model
+# file is associated with a MTL material libray file, used to assign colors
+# to spheres of different type.
#
# \param scatterer: `dict` Scatterer configuration dictionary (gets modified)
# \param geometry: `dict` Geometry configuration dictionary (gets modified)
--
GitLab