SILC Runtime Toolkit 1.2 Beta 1

[runtime.git] / lib / silcutil / silcdll.h

diff --git a/lib/silcutil/silcdll.h b/lib/silcutil/silcdll.h
index 3da325b4d96e4c5b09f5c6f74ee6a25c53a48965..3f3b8caef03d67d28855f48ad695fb7e678ad116 100644 (file)
--- a/lib/silcutil/silcdll.h
+++ b/lib/silcutil/silcdll.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2007 Pekka Riikonen
+  Copyright (C) 2007 - 2008 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -24,12 +24,25 @@
  * Platform independent iterface for loading and using shared objects and
  * dynamically linked libraries (DLLs).
  *
+ * EXAMPLE
+ *
+ * SilcDll dll;
+ * SilcFuncCb function;
+ *
+ * dll = silc_dll_load("/path/to/my.so");
+ * function = silc_dll_getsym(dll, "my_function");
+ *
+ * // Call the funtion
+ * function(arg1, arg2);
+ *
+ * silc_dll_close(dll);
+ *
  ***/
 
 #ifndef SILCDLL_H
 #define SILCDLL_H
 
-/****s* silcutil/SilcDLLAPI/SilcDll
+/****s* silcutil/SilcDll
  *
  * NAME
  *
@@ -50,7 +63,7 @@ typedef HMODULE SilcDll;
 typedef void *SilcDll;
 #endif /* SILC_UNIX */
 
-/****f* silcutil/SilcDLLAPI/silc_dll_load
+/****f* silcutil/silc_dll_load
  *
  * SYNOPSIS
  *
@@ -67,7 +80,7 @@ typedef void *SilcDll;
  ***/
 SilcDll silc_dll_load(const char *object_path);
 
-/****f* silcutil/SilcDLLAPI/silc_dll_close
+/****f* silcutil/silc_dll_close
  *
  * SYNOPSIS
  *
@@ -82,7 +95,7 @@ SilcDll silc_dll_load(const char *object_path);
  ***/
 void silc_dll_close(SilcDll dll);
 
-/****f* silcutil/SilcDLLAPI/silc_dll_getsym
+/****f* silcutil/silc_dll_getsym
  *
  * SYNOPSIS
  *
@@ -97,7 +110,7 @@ void silc_dll_close(SilcDll dll);
  ***/
 void *silc_dll_getsym(SilcDll dll, const char *symbol);
 
-/****f* silcutil/SilcDLLAPI/silc_dll_error
+/****f* silcutil/silc_dll_error
  *
  * SYNOPSIS
  *