Changeset 5440:3bd9f7ab48ed in roaraudio

Timestamp:

03/20/12 17:53:57 (12 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

added some comments

File:

• plugins/universal/helloworld.c (modified) (3 diffs)

plugins/universal/helloworld.c

@@ -26 +26 @@
 #include <roaraudio.h>
 
+// A simple function printing our message.
 static int hw_init (struct roar_dl_librarypara * para) {
- (void)para;
+ (void)para; // We ignore all parameters passed to us.
 
  roar_vio_printf(roar_stdout, "Hello world!\n");
@@ -34 +35 @@
 }
 
+// This struct contains the AppSched pointers.
 static struct roar_dl_appsched sched = {
  .init   = hw_init,
@@ -42 +44 @@
 };
 
+// This is the plugin control block.
 ROAR_DL_PLUGIN_START(helloworld) {
+ // Here we set the name and vendor of our plugin.
+ // If you have no Vendor ID you need to use ROAR_DL_PLUGIN_META_PRODUCT_NV().
  ROAR_DL_PLUGIN_META_PRODUCT_NIV("helloworld", ROAR_VID_ROARAUDIO, ROAR_VNAME_ROARAUDIO);
+
+ // This sets the version of your plugin.
  ROAR_DL_PLUGIN_META_VERSION(ROAR_VERSION_STRING);
+
+ // This sets the license of your plugin.
+ // If there is no tag for the license you use you can just
+ // use ROAR_DL_PLUGIN_META_LICENSE().
  ROAR_DL_PLUGIN_META_LICENSE_TAG(GPLv3_0);
+
+ // This sets the author and contact infos.
+ // There are several other macros to do this with other parameters.
+ // See ROAR_DL_PLUGIN_META_CONTACT*() in the header or documentation.
  ROAR_DL_PLUGIN_META_CONTACT_FLNE("Philipp", "Schafft", "ph3-der-loewe", "lion@lion.leolix.org");
+
+ // This sets the description for your plugin.
  ROAR_DL_PLUGIN_META_DESC("This plugin prints the string \"Hello world!\".");
+
+ // Here the AppSched block from above is registered.
  ROAR_DL_PLUGIN_REG_APPSCHED(&sched);
+
+// This is the end of the control block.
 } ROAR_DL_PLUGIN_END