From 53d7efcfb7b2e04225502100a18f9c923370c26e Mon Sep 17 00:00:00 2001
From: Mattijs Korpershoek <mattijs.korpershoek@gmail.com>
Date: Fri, 21 Mar 2014 09:05:15 +0100
Subject: Added comments for new plugin developers

As a new pfw plugin developer, i encountered an undocumented
(in the plugin) naming issue related to how the pfw
loads subsystem builders.

This patchs just added a comment to inform other
developers not to make the same mistake
---
 skeleton-subsystem/SkeletonSubsystemBuilder.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'skeleton-subsystem')

diff --git a/skeleton-subsystem/SkeletonSubsystemBuilder.cpp b/skeleton-subsystem/SkeletonSubsystemBuilder.cpp
index 08f2024..a6aae2d 100644
--- a/skeleton-subsystem/SkeletonSubsystemBuilder.cpp
+++ b/skeleton-subsystem/SkeletonSubsystemBuilder.cpp
@@ -34,6 +34,15 @@
 
 extern "C"
 {
+/**
+ * CARE: the naming convention used in the parameter framework:
+ *
+ * A plugin file name is of the form:
+ * lib<type>-subsystem.so or lib<type>-subsystem._host.so
+ *
+ * The plugin symbol is of the form:
+ * get<TYPE>SubsystemBuilder
+*/
 void getSKELETONSubsystemBuilder(CSubsystemLibrary* pSubsystemLibrary)
 {
     pSubsystemLibrary->addElementBuilder("Skeleton", new TNamedElementBuilderTemplate<CSkeletonSubsystem>());
-- 
cgit v1.1