update docblock

This commit is contained in:
Emiel Bruijntjes 2018-03-06 22:06:41 +01:00
parent 7aa7794e3e
commit 8065cfe940
1 changed files with 4 additions and 8 deletions

View File

@ -1,15 +1,12 @@
/** /**
* Function.h * Function.h
* *
* When you want to retrieve a function from a dynamicallly loaded * When you want to call a function only if it is already linked into
* library, you normally use the dlsym() function for that. The * the program space. you would normally use the dlsym() function for
* Function object is a little more convenient: * that. Th Function object in this file is a little more convenient:
*
* // open the library
* void *lib = dlopen("library.so");
* *
* // get the function object * // get the function object
* Function func<int(int)> magic_open(library, "my_function"); * Function func<int(int)> func("example_function");
* *
* // call the function * // call the function
* int result = func(123); * int result = func(123);
@ -18,7 +15,6 @@
* @copyright 2018 Copernica BV * @copyright 2018 Copernica BV
*/ */
/** /**
* Include guard * Include guard
*/ */