added documentation and cleanup

robotology · Jan 7, 2019 · 392c864 · 392c864
1 parent 2097ba2
commit 392c864
Show file tree

Hide file tree

Showing 16 changed files with 109 additions and 57 deletions.
diff --git a/cmake/template/yarp_plugin_RFModule.cpp.in b/cmake/template/yarp_plugin_RFModule.cpp.in
@@ -5,6 +5,7 @@
  * This software may be modified and distributed under the terms of the
  * BSD-3-Clause license. See the accompanying LICENSE file for details.
  */
+
 #include <yarp/conf/api.h>
 #include <yarp/os/RFModuleFactory.h>
 #include <yarp/os/SharedLibraryClass.h>

diff --git a/example/RFModulePlugin/CMakeLists.txt b/example/RFModulePlugin/CMakeLists.txt
@@ -1,9 +1,8 @@
-################################################################################
-#                                                                              #
-# Copyright (C) 2017 Fondazione Istituto Italiano di Tecnologia (IIT)          #
-# All Rights Reserved.                                                         #
-#                                                                              #
-################################################################################
+# Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+# All rights reserved.
+#
+# This software may be modified and distributed under the terms of the
+# BSD-3-Clause license. See the accompanying LICENSE file for details.
 
 cmake_minimum_required(VERSION 3.5)
 project(myModules)

diff --git a/example/RFModulePlugin/moduleLoader/CMakeLists.txt b/example/RFModulePlugin/moduleLoader/CMakeLists.txt
@@ -1,4 +1,10 @@
+# Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+# All rights reserved.
+#
+# This software may be modified and distributed under the terms of the
+# BSD-3-Clause license. See the accompanying LICENSE file for details.
+
 set(SRC main.cpp)
 add_executable(moduleLoader ${SRC})
 target_link_libraries(moduleLoader YARP::YARP_OS
-                                   YARP::YARP_init)
+                                   YARP::YARP_init)
diff --git a/example/RFModulePlugin/moduleLoader/main.cpp b/example/RFModulePlugin/moduleLoader/main.cpp
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
+
 #include <yarp/os/RFPlugin.h>
 #include <yarp/os/Time.h>
 #include <memory>
@@ -28,4 +36,4 @@ int main()
     }
 
 	return 0;
-}
+}
diff --git a/example/RFModulePlugin/testmoduleBar/CMakeLists.txt b/example/RFModulePlugin/testmoduleBar/CMakeLists.txt
@@ -1,13 +1,11 @@
-################################################################################
-#                                                                              #
-# Copyright (C) 2018 Fondazione Istituto Italiano di Tecnologia (IIT)          #
-# All Rights Reserved.                                                         #
-#                                                                              #
-################################################################################
+# Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+# All rights reserved.
+#
+# This software may be modified and distributed under the terms of the
+# BSD-3-Clause license. See the accompanying LICENSE file for details.
 
 include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 
-set(SRC module.cpp)
 set(HDRS module.h)
 
 yarp_prepare_plugin(myModuleBar
@@ -16,7 +14,7 @@ yarp_prepare_plugin(myModuleBar
                     INCLUDE module.h)
 
 if(ENABLE_myModules_myModuleBar)
-  yarp_add_plugin(module_Bar ${SRC} ${HDRS})
+  yarp_add_plugin(module_Bar ${HDRS})
   target_link_libraries(module_Bar YARP::YARP_OS)
 endif()
 

diff --git a/example/RFModulePlugin/testmoduleBar/main.cpp b/example/RFModulePlugin/testmoduleBar/main.cpp
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
+
 #include <module.h>
 #include <yarp/os/Network.h>
 int main(int argc, char** argv)

diff --git a/example/RFModulePlugin/testmoduleBar/module.cpp b/example/RFModulePlugin/testmoduleBar/module.cpp
diff --git a/example/RFModulePlugin/testmoduleBar/module.h b/example/RFModulePlugin/testmoduleBar/module.h
@@ -1,9 +1,10 @@
-/******************************************************************************
- *                                                                            *
- * Copyright (C) 2018 Fondazione Istituto Italiano di Tecnologia (IIT)        *
- * All Rights Reserved.                                                       *
- *                                                                            *
- ******************************************************************************/
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
 
 
 #include <yarp/os/RFModule.h>

diff --git a/example/RFModulePlugin/testmoduleFoo/CMakeLists.txt b/example/RFModulePlugin/testmoduleFoo/CMakeLists.txt
@@ -1,13 +1,11 @@
-################################################################################
-#                                                                              #
-# Copyright (C) 2018 Fondazione Istituto Italiano di Tecnologia (IIT)          #
-# All Rights Reserved.                                                         #
-#                                                                              #
-################################################################################
+# Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+# All rights reserved.
+#
+# This software may be modified and distributed under the terms of the
+# BSD-3-Clause license. See the accompanying LICENSE file for details.
 
 include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 
-set(SRC module.cpp)
 set(HDRS module.h)
 
 yarp_prepare_plugin(myModuleFoo
@@ -16,7 +14,7 @@ yarp_prepare_plugin(myModuleFoo
                     INCLUDE module.h)
 
 if(ENABLE_myModules_myModuleFoo)
-  yarp_add_plugin(module_Foo ${SRC} ${HDRS})
+  yarp_add_plugin(module_Foo ${HDRS})
   target_link_libraries(module_Foo YARP::YARP_OS)
 endif()
 

diff --git a/example/RFModulePlugin/testmoduleFoo/main.cpp b/example/RFModulePlugin/testmoduleFoo/main.cpp
@@ -1,3 +1,11 @@
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
+
 #include <module.h>
 #include <yarp/os/Network.h>
 int main(int argc, char** argv)

diff --git a/example/RFModulePlugin/testmoduleFoo/module.cpp b/example/RFModulePlugin/testmoduleFoo/module.cpp
diff --git a/example/RFModulePlugin/testmoduleFoo/module.h b/example/RFModulePlugin/testmoduleFoo/module.h
@@ -1,10 +1,10 @@
-/******************************************************************************
- *                                                                            *
- * Copyright (C) 2018 Fondazione Istituto Italiano di Tecnologia (IIT)        *
- * All Rights Reserved.                                                       *
- *                                                                            *
- ******************************************************************************/
-
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
 
 #include <yarp/os/RFModule.h>
 #include <yarp/os/Time.h>

diff --git a/src/libYARP_OS/include/yarp/os/RFPlugin.h b/src/libYARP_OS/include/yarp/os/RFPlugin.h
@@ -1,3 +1,10 @@
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
 
 #include <yarp/os/api.h>
 #include <string>
@@ -17,17 +24,32 @@ class YARP_OS_API RFPlugin
     RFPlugin();
 
     virtual ~RFPlugin();
-
+
+    /**
+     * opens the plugin
+     * @param command a string containing the equivalent command line
+     * @return true if opened succesfully
+     */
     virtual bool open(const std::string& command);
 
+    /**
+     * closes the plugin
+     */
     virtual void close();
 
+    /**
+     * check if the plugin is running
+     */
     virtual bool isRunning();
 
+    /**
+     * get the command line used to open the plugin
+     */
     virtual std::string getCmd();
 
-    virtual std::string getAlias();
-
+    /**
+     * get the thread id
+     */
     virtual int getThreadKey();
 };
 

diff --git a/src/libYARP_OS/include/yarp/os/impl/RFModuleFactory.h b/src/libYARP_OS/include/yarp/os/impl/RFModuleFactory.h
@@ -1,10 +1,11 @@
 /*
-* Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
-* All rights reserved.
-*
-* This software may be modified and distributed under the terms of the
-* BSD-3-Clause license. See the accompanying LICENSE file for details.
-*/
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
+
 #ifndef YARP_OS_RFPLUGINFACTORY_H
 #define YARP_OS_RFPLUGINFACTORY_H
 

diff --git a/src/libYARP_OS/src/RFModuleFactory.cpp b/src/libYARP_OS/src/RFModuleFactory.cpp
@@ -1,10 +1,10 @@
 /*
-* Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
-* All rights reserved.
-*
-* This software may be modified and distributed under the terms of the
-* BSD-3-Clause license. See the accompanying LICENSE file for details.
-*/
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
 
 #include <yarp/os/YarpPluginSettings.h>
 

diff --git a/src/libYARP_OS/src/RFPlugin.cpp b/src/libYARP_OS/src/RFPlugin.cpp
@@ -1,3 +1,10 @@
+/*
+ * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
+ * All rights reserved.
+ *
+ * This software may be modified and distributed under the terms of the
+ * BSD-3-Clause license. See the accompanying LICENSE file for details.
+ */
 
 #include <yarp/os/RFPlugin.h>
 #include <yarp/os/YarpPluginSelector.h>
@@ -55,11 +62,6 @@ string RFPlugin::getCmd()
     return impl->command;
 }
 
-string RFPlugin::getAlias()
-{
-    return impl->alias;
-}
-
 int RFPlugin::getThreadKey()
 {
     return impl->module->getThreadKey();