Flutter plugins: add notes, CMake min 3.10 for Linux, 3.14 for Windows.

Author: greenrobot-team

flutter_libs/linux/CMakeLists.txt

@@ -1,30 +1,53 @@
-cmake_minimum_required(VERSION 3.11)
+# The Flutter tooling requires that developers have CMake 3.10 or later
+# installed. You should not increase this version, as doing so will cause
+# the plugin to fail to compile for some customers of the plugin.
+cmake_minimum_required(VERSION 3.10)
+
+# Project-level configuration.
 set(PROJECT_NAME "objectbox_flutter_libs")
 project(${PROJECT_NAME} LANGUAGES CXX)
 
 # This value is used when generating builds using this plugin, so it must
-# not be changed
+# not be changed.
 set(PLUGIN_NAME "objectbox_flutter_libs_plugin")
 
+# Define the plugin library target. Its name must not be changed (see comment
+# on PLUGIN_NAME above).
+#
+# Any new source files that you add to the plugin should be added here.
 add_library(${PLUGIN_NAME} SHARED
   "objectbox_flutter_libs_plugin.cc"
 )
+
+# Apply a standard set of build settings that are configured in the
+# application-level CMakeLists.txt. This can be removed for plugins that want
+# full control over build settings.
 apply_standard_settings(${PLUGIN_NAME})
+
+# Symbols are hidden by default to reduce the chance of accidental conflicts
+# between plugins. This should not be removed; any symbols that should be
+# exported should be explicitly exported with the FLUTTER_PLUGIN_EXPORT macro.
 set_target_properties(${PLUGIN_NAME} PROPERTIES
   CXX_VISIBILITY_PRESET hidden)
 target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL)
+
+# Source include directories and library dependencies. Add any plugin-specific
+# dependencies here.
 target_include_directories(${PLUGIN_NAME} INTERFACE
   "${CMAKE_CURRENT_SOURCE_DIR}/include")
 target_link_libraries(${PLUGIN_NAME} PRIVATE flutter)
 target_link_libraries(${PLUGIN_NAME} PRIVATE PkgConfig::GTK)
 
-# List of absolute paths to libraries that should be bundled with the plugin
+# List of absolute paths to libraries that should be bundled with the plugin.
+# This list could contain prebuilt libraries, or libraries created by an
+# external build triggered from this build file.
 set(objectbox_flutter_libs_bundled_libraries
   ""
   PARENT_SCOPE
 )
 
 # ----------------------------------------------------------------------
+# Download and add objectbox-c prebuilt library.
 
 set(OBJECTBOX_VERSION 0.18.0)
 
@@ -48,6 +71,7 @@ if(NOT objectbox-download_POPULATED)
   FetchContent_Populate(objectbox-download)
 endif()
 
+# Bundle library with Flutter plugin, see template above.
 set(objectbox_flutter_libs_bundled_libraries
     "${objectbox-download_SOURCE_DIR}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}objectbox${CMAKE_SHARED_LIBRARY_SUFFIX}"
     PARENT_SCOPE

flutter_libs/windows/CMakeLists.txt

@@ -1,29 +1,51 @@
-cmake_minimum_required(VERSION 3.15)
+# The Flutter tooling requires that developers have a version of Visual Studio
+# installed that includes CMake 3.14 or later. You should not increase this
+# version, as doing so will cause the plugin to fail to compile for some
+# customers of the plugin.
+cmake_minimum_required(VERSION 3.14)
+
+# Project-level configuration.
 set(PROJECT_NAME "objectbox_flutter_libs")
 project(${PROJECT_NAME} LANGUAGES CXX)
 
 # This value is used when generating builds using this plugin, so it must
 # not be changed
 set(PLUGIN_NAME "objectbox_flutter_libs_plugin")
 
+# Define the plugin library target. Its name must not be changed (see comment
+# on PLUGIN_NAME above).
 add_library(${PLUGIN_NAME} SHARED
   "objectbox_flutter_libs_plugin.cpp"
 )
+
+# Apply a standard set of build settings that are configured in the
+# application-level CMakeLists.txt. This can be removed for plugins that want
+# full control over build settings.
 apply_standard_settings(${PLUGIN_NAME})
+
+# Symbols are hidden by default to reduce the chance of accidental conflicts
+# between plugins. This should not be removed; any symbols that should be
+# exported should be explicitly exported with the FLUTTER_PLUGIN_EXPORT macro.
 set_target_properties(${PLUGIN_NAME} PROPERTIES
   CXX_VISIBILITY_PRESET hidden)
 target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL)
+
+# Source include directories and library dependencies. Add any plugin-specific
+# dependencies here.
 target_include_directories(${PLUGIN_NAME} INTERFACE
   "${CMAKE_CURRENT_SOURCE_DIR}/include")
 target_link_libraries(${PLUGIN_NAME} PRIVATE flutter flutter_wrapper_plugin)
 
-# List of absolute paths to libraries that should be bundled with the plugin
+# List of absolute paths to libraries that should be bundled with the plugin.
+# This list could contain prebuilt libraries, or libraries created by an
+# external build triggered from this build file.
 set(objectbox_flutter_libs_bundled_libraries
   ""
   PARENT_SCOPE
 )
 
 # ----------------------------------------------------------------------
+# Download and add objectbox-c prebuilt library.
 
 set(OBJECTBOX_VERSION 0.18.0)
 

sync_flutter_libs/linux/CMakeLists.txt

@@ -1,30 +1,53 @@
+# The Flutter tooling requires that developers have CMake 3.10 or later
+# installed. You should not increase this version, as doing so will cause
+# the plugin to fail to compile for some customers of the plugin.
 cmake_minimum_required(VERSION 3.10)
+
+# Project-level configuration.
 set(PROJECT_NAME "objectbox_sync_flutter_libs")
 project(${PROJECT_NAME} LANGUAGES CXX)
 
 # This value is used when generating builds using this plugin, so it must
-# not be changed
+# not be changed.
 set(PLUGIN_NAME "objectbox_sync_flutter_libs_plugin")
 
+# Define the plugin library target. Its name must not be changed (see comment
+# on PLUGIN_NAME above).
+#
+# Any new source files that you add to the plugin should be added here.
 add_library(${PLUGIN_NAME} SHARED
   "objectbox_sync_flutter_libs_plugin.cc"
 )
+
+# Apply a standard set of build settings that are configured in the
+# application-level CMakeLists.txt. This can be removed for plugins that want
+# full control over build settings.
 apply_standard_settings(${PLUGIN_NAME})
+
+# Symbols are hidden by default to reduce the chance of accidental conflicts
+# between plugins. This should not be removed; any symbols that should be
+# exported should be explicitly exported with the FLUTTER_PLUGIN_EXPORT macro.
 set_target_properties(${PLUGIN_NAME} PROPERTIES
   CXX_VISIBILITY_PRESET hidden)
 target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL)
+
+# Source include directories and library dependencies. Add any plugin-specific
+# dependencies here.
 target_include_directories(${PLUGIN_NAME} INTERFACE
   "${CMAKE_CURRENT_SOURCE_DIR}/include")
 target_link_libraries(${PLUGIN_NAME} PRIVATE flutter)
 target_link_libraries(${PLUGIN_NAME} PRIVATE PkgConfig::GTK)
 
-# List of absolute paths to libraries that should be bundled with the plugin
+# List of absolute paths to libraries that should be bundled with the plugin.
+# This list could contain prebuilt libraries, or libraries created by an
+# external build triggered from this build file.
 set(objectbox_sync_flutter_libs_bundled_libraries
   ""
   PARENT_SCOPE
 )
 
 # ----------------------------------------------------------------------
+# Download and add objectbox-c prebuilt library.
 
 set(OBJECTBOX_VERSION 0.18.0)
 
@@ -48,6 +71,7 @@ if(NOT objectbox-download_POPULATED)
   FetchContent_Populate(objectbox-download)
 endif()
 
+# Bundle library with Flutter plugin, see template above.
 set(objectbox_sync_flutter_libs_bundled_libraries
     "${objectbox-download_SOURCE_DIR}/lib/${CMAKE_SHARED_LIBRARY_PREFIX}objectbox${CMAKE_SHARED_LIBRARY_SUFFIX}"
     PARENT_SCOPE

sync_flutter_libs/windows/CMakeLists.txt

@@ -1,29 +1,51 @@
-cmake_minimum_required(VERSION 3.15)
+# The Flutter tooling requires that developers have a version of Visual Studio
+# installed that includes CMake 3.14 or later. You should not increase this
+# version, as doing so will cause the plugin to fail to compile for some
+# customers of the plugin.
+cmake_minimum_required(VERSION 3.14)
+
+# Project-level configuration.
 set(PROJECT_NAME "objectbox_sync_flutter_libs")
 project(${PROJECT_NAME} LANGUAGES CXX)
 
 # This value is used when generating builds using this plugin, so it must
 # not be changed
 set(PLUGIN_NAME "objectbox_sync_flutter_libs_plugin")
 
+# Define the plugin library target. Its name must not be changed (see comment
+# on PLUGIN_NAME above).
 add_library(${PLUGIN_NAME} SHARED
   "objectbox_sync_flutter_libs_plugin.cpp"
 )
+
+# Apply a standard set of build settings that are configured in the
+# application-level CMakeLists.txt. This can be removed for plugins that want
+# full control over build settings.
 apply_standard_settings(${PLUGIN_NAME})
+
+# Symbols are hidden by default to reduce the chance of accidental conflicts
+# between plugins. This should not be removed; any symbols that should be
+# exported should be explicitly exported with the FLUTTER_PLUGIN_EXPORT macro.
 set_target_properties(${PLUGIN_NAME} PROPERTIES
   CXX_VISIBILITY_PRESET hidden)
 target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL)
+
+# Source include directories and library dependencies. Add any plugin-specific
+# dependencies here.
 target_include_directories(${PLUGIN_NAME} INTERFACE
   "${CMAKE_CURRENT_SOURCE_DIR}/include")
 target_link_libraries(${PLUGIN_NAME} PRIVATE flutter flutter_wrapper_plugin)
 
-# List of absolute paths to libraries that should be bundled with the plugin
+# List of absolute paths to libraries that should be bundled with the plugin.
+# This list could contain prebuilt libraries, or libraries created by an
+# external build triggered from this build file.
 set(objectbox_sync_flutter_libs_bundled_libraries
   ""
   PARENT_SCOPE
 )
 
 # ----------------------------------------------------------------------
+# Download and add objectbox-c prebuilt library.
 
 set(OBJECTBOX_VERSION 0.18.0)