Commit 69751ef1 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Fix inline documentation comments of model maker

parent 2f434400

src/scripts/model_maker.py

+4 −4
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ except ModuleNotFoundError as ex: 
from pathlib import Path

from sys import argv



## \brief Main execution code

## \brief Main execution code.

#

# `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.
@@ -73,7 +73,7 @@ def main(): 
            result = 1

    return result



## \brief Populate the dielectric constant data via interpolation

## \brief Populate the dielectric constant data via interpolation.

#

#  \param sconf: `dict` Scatterer configuration dictionary.

#  \return result: `int` An exit code (0 if successful).
@@ -643,7 +643,7 @@ def parse_arguments(): 
def print_help():

    print("###############################################           ")

    print("#                                             #           ")

    print("#           NPTM_code MODEL_MAKER             #           ")

    print("#           NP_TMcode MODEL_MAKER             #           ")

    print("#                                             #           ")

    print("###############################################           ")

    print("                                                          ")
@@ -1430,6 +1430,6 @@ def write_obj(scatterer, geometry, max_rad): 
    os.remove(str(Path(str(out_dir), "TMP_MODEL.obj")))

    os.remove(str(Path(str(out_dir), "TMP_MODEL.mtl")))



## \brief Exit code (0 for success)

## \brief Exit code (0 for success).

exit_code = main()

exit(exit_code)