changeset 576:943d07fbe352

Dynlib: reduce column limit
author David Demelier <markand@malikania.fr>
date Tue, 19 Jul 2016 22:38:12 +0200
parents 0f6501d6df34
children d0b9ce94b857
files modules/dynlib/dynlib.hpp
diffstat 1 files changed, 20 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/modules/dynlib/dynlib.hpp	Tue Jul 19 22:35:42 2016 +0200
+++ b/modules/dynlib/dynlib.hpp	Tue Jul 19 22:38:12 2016 +0200
@@ -42,11 +42,12 @@
  *
  * ## How to export symbols
  *
- * When you want to dynamically load symbols from your shared library, make sure they are in a `extern "C"` block, if
- * not they will be [mangled][name-mangling].
+ * When you want to dynamically load symbols from your shared library, make
+ * sure they are in a `extern "C"` block, if not they will be
+ * [mangled][name-mangling].
  *
- * Note, this does not mean that you can't write C++ code, it just mean that you can't use namespaces and function
- * overloading.
+ * Note, this does not mean that you can't write C++ code, it just mean that
+ * you can't use namespaces and function overloading.
  *
  * Example of **plugin.cpp**:
  *
@@ -70,10 +71,11 @@
  * }
  * ````
  *
- * The \ref DYNLIB_EXPORT macro is necessary on some platforms to be sure that symbol will be visible. Make sure you always
- * add it before any function.
+ * The \ref DYNLIB_EXPORT macro is necessary on some platforms to be sure that
+ * symbols will be visible. Make sure you always add it before any function.
  *
- * To compile, see your compiler documentation or build system. For gcc you can use the following:
+ * To compile, see your compiler documentation or build system. For gcc you can
+ * use the following:
  *
  * ````
  * gcc -std=c++14 -shared plugin.cpp -o plugin.so
@@ -81,8 +83,9 @@
  *
  * ## How to load the library
  *
- * The dynlib module will search for the library in various places, thus you can use relative paths names but be sure
- * that the library can be found. Otherwise, just use an absolute path to the file.
+ * The dynlib module will search for the library in various places, thus you
+ * can use relative paths names but be sure that the library can be found.
+ * Otherwise, just use an absolute path to the file.
  *
  * ````cpp
  * #include <iostream>
@@ -103,7 +106,8 @@
  *
  * ## How to load symbol
  *
- * The last part is symbol loading, you muse use raw C function pointer and the Dynlib::sym function.
+ * The last part is symbol loading, you muse use raw C function pointer and
+ * the Dynlib::sym function.
  *
  * ````cpp
  * #include <iostream>
@@ -143,7 +147,8 @@
 /**
  * \brief Export the symbol.
  *
- * This is required on some platforms and you should put it before your function signature.
+ * This is required on some platforms and you should put it before your
+ * function signature.
  *
  * \code{.cpp}
  * extern "C" {
@@ -170,7 +175,8 @@
  * Dynlib library("./myplugin" DYNLIB_SUFFIX);
  * \endcode
  *
- * \note Don't use the suffix expanded value shown in Doxygen as it may be wrong.
+ * \note Don't use the suffix expanded value shown in Doxygen as it may be
+ * wrong.
  */
 #if defined(_WIN32)
 #  define DYNLIB_SUFFIX ".dll"
@@ -184,7 +190,8 @@
  * \class Dynlib
  * \brief Load a dynamic module.
  *
- * This class is a portable wrapper to load shared libraries on supported systems.
+ * This class is a portable wrapper to load shared libraries on supported
+ * systems.
  */
 class Dynlib {
 private: