diff options
| author | Mattijs Korpershoek <mattijs.korpershoek@gmail.com> | 2014-03-21 09:05:15 +0100 |
|---|---|---|
| committer | Mattijs Korpershoek <mattijs.korpershoek@gmail.com> | 2014-03-21 09:17:23 +0100 |
| commit | 53d7efcfb7b2e04225502100a18f9c923370c26e (patch) | |
| tree | 775ce2fc4d3bf8b0eb7a17c63465fd5dc095d25c /skeleton-subsystem | |
| parent | ab793c78e50d07f4fd05714c4502eb2ef8138b71 (diff) | |
| download | external_parameter-framework-53d7efcfb7b2e04225502100a18f9c923370c26e.zip external_parameter-framework-53d7efcfb7b2e04225502100a18f9c923370c26e.tar.gz external_parameter-framework-53d7efcfb7b2e04225502100a18f9c923370c26e.tar.bz2 | |
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
Diffstat (limited to 'skeleton-subsystem')
| -rw-r--r-- | skeleton-subsystem/SkeletonSubsystemBuilder.cpp | 9 |
1 files changed, 9 insertions, 0 deletions
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>()); |