update the BSK module template to not use @return void

AVSLab · Dec 30, 2024 · a46a3b4 · a46a3b4
1 parent 07e67db
commit a46a3b4
Showing 1 changed file with 3 additions and 5 deletions.
diff --git a/src/utilities/makeDraftModule.py b/src/utilities/makeDraftModule.py
@@ -372,7 +372,6 @@ def createCppModule(self):
         defFile += '}\n'
         defFile += '\n'
         defFile += '/*! This method is used to reset the module and checks that required input messages are connect.\n'
-        defFile += '    @return void\n'
         defFile += '*/\n'
         defFile += f'void {self._className}::Reset(uint64_t CurrentSimNanos)\n'
         defFile += '{\n'
@@ -387,7 +386,6 @@ def createCppModule(self):
         defFile += '\n'
         defFile += '/*! This is the main method that gets called every time the module is updated.  ' \
                    'Provide an appropriate description.\n'
-        defFile += '    @return void\n'
         defFile += '*/\n'
         defFile += f'void {self._className}::UpdateState(uint64_t CurrentSimNanos)\n'
         defFile += '{\n'
@@ -568,7 +566,7 @@ def createCModule(self):
         defFile += '\n'
         defFile += '/*!\n'
         defFile += '    This method initializes the output messages for this module.\n'
-        defFile += ' @return void\n'
+        defFile += '\n'
         defFile += ' @param configData The configuration data associated with this module\n'
         defFile += ' @param moduleID The module identifier\n'
         defFile += ' */\n'
@@ -582,7 +580,7 @@ def createCModule(self):
         defFile += '/*! This method performs a complete reset of the module.  Local module variables that retain\n'
         defFile += '    time varying states between function calls are reset to their default values.\n'
         defFile += '    Check if required input messages are connected.\n'
-        defFile += ' @return void\n'
+        defFile += '\n'
         defFile += ' @param configData The configuration data associated with the module\n'
         defFile += ' @param callTime [ns] time the method is called\n'
         defFile += ' @param moduleID The module identifier\n'
@@ -600,7 +598,7 @@ def createCModule(self):
         defFile += '\n'
         defFile += '\n'
         defFile += '/*! Add a description of what this main Update() routine does for this module\n'
-        defFile += ' @return void\n'
+        defFile += '\n'
         defFile += ' @param configData The configuration data associated with the module\n'
         defFile += ' @param callTime The clock time at which the function was called (nanoseconds)\n'
         defFile += ' @param moduleID The module identifier\n'