Added watcom_util to Sphinx

burgerbecky · Oct 6, 2024 · e256100 · e256100
1 parent 78b19f3
commit e256100
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 1 deletion.
diff --git a/docs/functions.rst b/docs/functions.rst
@@ -267,3 +267,46 @@ defaults.default_configuration_list
 defaults.get_configuration_list
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. doxygenfunction:: makeprojects::defaults::get_configuration_list
+
+Watcom
+------
+
+watcom_util.fixup_env
+^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::fixup_env
+
+watcom_util.convert_file_name_watcom
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::convert_file_name_watcom
+
+watcom_util.get_element_dict
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::get_element_dict
+
+watcom_util.get_custom_list
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::get_custom_list
+
+watcom_util.get_output_list
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::get_output_list
+
+watcom_util.get_obj_list
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::get_obj_list
+
+watcom_util.add_obj_list
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::add_obj_list
+
+watcom_util.add_post_build
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::add_post_build
+
+watcom_util.watcom_linker_system
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::watcom_linker_system
+
+watcom_util.warn_if_invalid
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. doxygenfunction:: makeprojects::watcom_util::warn_if_invalid
diff --git a/makeprojects/watcom.py b/makeprojects/watcom.py
@@ -44,7 +44,8 @@
     get_output_template
 from .build_objects import BuildObject, BuildError
 from .watcom_util import fixup_env, get_custom_list, get_output_list, \
-    add_post_build, watcom_linker_system, get_obj_list, add_obj_list
+    add_post_build, watcom_linker_system, get_obj_list, add_obj_list, \
+    warn_if_invalid
 
 # IDEs supported by this generator
 SUPPORTED_IDES = (IDETypes.watcom,)
@@ -275,6 +276,10 @@ def generate(solution):
     if solution.ide not in SUPPORTED_IDES:
         return 10
 
+    error = warn_if_invalid(solution)
+    if error:
+        return error
+
     # Create the output filename and pass it to the generator
     # so it can reference itself in make targets
     solution.watcom_filename = "{}{}{}.wmk".format(