Changeset 5440:3bd9f7ab48ed in roaraudio


Ignore:
Timestamp:
03/20/12 17:53:57 (10 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

added some comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • plugins/universal/helloworld.c

    r5439 r5440  
    2626#include <roaraudio.h> 
    2727 
     28// A simple function printing our message. 
    2829static int hw_init (struct roar_dl_librarypara * para) { 
    29  (void)para; 
     30 (void)para; // We ignore all parameters passed to us. 
    3031 
    3132 roar_vio_printf(roar_stdout, "Hello world!\n"); 
     
    3435} 
    3536 
     37// This struct contains the AppSched pointers. 
    3638static struct roar_dl_appsched sched = { 
    3739 .init   = hw_init, 
     
    4244}; 
    4345 
     46// This is the plugin control block. 
    4447ROAR_DL_PLUGIN_START(helloworld) { 
     48 // Here we set the name and vendor of our plugin. 
     49 // If you have no Vendor ID you need to use ROAR_DL_PLUGIN_META_PRODUCT_NV(). 
    4550 ROAR_DL_PLUGIN_META_PRODUCT_NIV("helloworld", ROAR_VID_ROARAUDIO, ROAR_VNAME_ROARAUDIO); 
     51 
     52 // This sets the version of your plugin. 
    4653 ROAR_DL_PLUGIN_META_VERSION(ROAR_VERSION_STRING); 
     54 
     55 // This sets the license of your plugin. 
     56 // If there is no tag for the license you use you can just 
     57 // use ROAR_DL_PLUGIN_META_LICENSE(). 
    4758 ROAR_DL_PLUGIN_META_LICENSE_TAG(GPLv3_0); 
     59 
     60 // This sets the author and contact infos. 
     61 // There are several other macros to do this with other parameters. 
     62 // See ROAR_DL_PLUGIN_META_CONTACT*() in the header or documentation. 
    4863 ROAR_DL_PLUGIN_META_CONTACT_FLNE("Philipp", "Schafft", "ph3-der-loewe", "lion@lion.leolix.org"); 
     64 
     65 // This sets the description for your plugin. 
    4966 ROAR_DL_PLUGIN_META_DESC("This plugin prints the string \"Hello world!\"."); 
     67 
     68 // Here the AppSched block from above is registered. 
    5069 ROAR_DL_PLUGIN_REG_APPSCHED(&sched); 
     70 
     71// This is the end of the control block. 
    5172} ROAR_DL_PLUGIN_END 
    5273 
Note: See TracChangeset for help on using the changeset viewer.