updated

add_plumed_plugin comment
Iximiel · Aug 18, 2023 · cd9e60b · cd9e60b
1 parent 3e8f7ea
commit cd9e60b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/cmake/PlumedUserMacros.cmake b/src/cmake/PlumedUserMacros.cmake
@@ -7,6 +7,12 @@ macro(add_plumed_plugin plugin_name)
   #This creates a target library called <plugin_name> that is linked to
   #Plumed2::Config and has will produce a <plugin_name>.so or <plugin_name>.dylib
   #You can add extra libraries by using the standard target_link_libraries()
+  # this macro is equivalent to
+  # ```cmake
+  # add_library(<plugin_name> SHARED <listOfSources>)
+  # target_link_libraries(<plugin_name>PUBLIC Plumed2::Config)
+  # set_target_properties(<plugin_name> PROPERTIES PREFIX "")
+  #```
 
   set(options "")
   set(oneValueArgs "")