Add link to CMake API in new-generated code (#201)

* Add link to CMake API in `new`-generated code * Shorten link * formatting * Adding note module names. * Adding note on module names and commenting out MOD_DEPS --------- Co-authored-by: M Starch <[email protected]>
nasa · May 2, 2024 · 17f7d14 · 17f7d14
1 parent c15253c
commit 17f7d14
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 3 deletions.
diff --git a/...er_templates/cookiecutter-fprime-component/{{cookiecutter.component_name}}/CMakeLists.txt b/...er_templates/cookiecutter-fprime-component/{{cookiecutter.component_name}}/CMakeLists.txt
@@ -1,21 +1,30 @@
 ####
-# F prime CMakeLists.txt:
+# FPrime CMakeLists.txt:
 #
 # SOURCE_FILES: combined list of source and autocoding files
 # MOD_DEPS: (optional) module dependencies
 # UT_SOURCE_FILES: list of source files for unit tests
 #
+# More information in the F´ CMake API documentation:
+# https://nasa.github.io/fprime/UsersGuide/api/cmake/API.html
+#
 ####
+
 set(SOURCE_FILES
   "${CMAKE_CURRENT_LIST_DIR}/{{cookiecutter.component_name}}.fpp"
   "${CMAKE_CURRENT_LIST_DIR}/{{cookiecutter.component_name}}.cpp"
 )
 
 # Uncomment and add any modules that this component depends on, else
 # they might not be available when cmake tries to build this component.
-
+#
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer. i.e. The module defined by
+# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.  `Ref/SignalGen`
+# is an acceptable alternative and will be internally converted to `Ref_SignalGen`.
+#
 # set(MOD_DEPS
-#     Add your dependencies here
+#   MyPackage_MyOtherModule
 # )
 
 register_fprime_module()
diff --git a/...iecutter_templates/cookiecutter-fprime-module/{{cookiecutter.module_name}}/CMakeLists.txt b/...iecutter_templates/cookiecutter-fprime-module/{{cookiecutter.module_name}}/CMakeLists.txt
@@ -1,5 +1,29 @@
+####
+# FPrime CMakeLists.txt:
+#
+# SOURCE_FILES: combined list of source and autocoding files
+# MOD_DEPS: (optional) module dependencies
+# UT_SOURCE_FILES: list of source files for unit tests
+#
+# More information in the F´ CMake API documentation:
+# https://nasa.github.io/fprime/UsersGuide/api/cmake/API.html
+#
+####
+
 set(SOURCE_FILES
   "${CMAKE_CURRENT_LIST_DIR}/{{cookiecutter.module_name}}.fpp"
 )
 
+# Uncomment and add any modules that this module depends on, else
+# they might not be available when cmake tries to build this module.
+#
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer. i.e. The module defined by
+# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.  `Ref/SignalGen`
+# is an acceptable alternative and will be internally converted to `Ref_SignalGen`.
+#
+#set(MOD_DEPS
+#  MyPackage_MyOtherModule
+#)
+
 register_fprime_module()