From cd9e60ba225b06ac07d196b25b6907288ef5947b Mon Sep 17 00:00:00 2001
From: Daniele Rapetti <daniele.rapetti@sissa.it>
Date: Fri, 18 Aug 2023 11:59:08 +0200
Subject: [PATCH] updated add_plumed_plugin comment

---
 src/cmake/PlumedUserMacros.cmake | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/cmake/PlumedUserMacros.cmake b/src/cmake/PlumedUserMacros.cmake
index aad3c7b042..2091a982c6 100644
--- 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 "")