boost/dll
2
0
Fork 0
mirror of https://github.com/boostorg/dll.git synced 2026-01-19 04:12:08 +00:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source 
Fixes: https://github.com/boostorg/dll/issues/51
This commit is contained in:
Antony Polukhin
2025-01-14 21:46:32 +03:00
parent cb815af057
commit e2ca8d9ce8
4 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Jamfile.v2
View File

@@ -1,5 +1,5 @@
# Copyright (c) 2014 Renato Tegon Forti, Antony Polukhin.
# Copyright (c) 2015-2019 Antony Polukhin.
# Copyright (c) 2015-2025 Antony Polukhin.
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -81,7 +81,7 @@ boostbook dll-doc
:
<dependency>autodoc_shared_library_core
<dependency>autodoc_shared_library_refcountable
<xsl:param>boost.root=http://www.boost.org/doc/libs/1_60_0
<xsl:param>boost.root=http://www.boost.org/doc/libs/1_87_0
#<xsl:param>boost.root=../../../.
<xml:param>html.stylesheet=../../../../doc/src/boostbook.css
;

4
doc/getting_started.qbk
View File

@@ -7,7 +7,9 @@
[section:getting_started Getting started]
Boost.DLL is a header only library. To start with the library you only need to include `<boost/dll.hpp>` header. After that you are free to import and export functions and variables. Importing code requires linking with `boost_filesystem` and `boost_system` libraries.
Boost.DLL is a header only library. To start with the library you only need to include `<boost/dll.hpp>` header. After that you are free to import and export functions and variables.
`boost::dll::import*` functions require linking with `boost_filesystem` and `boost_system` libraries, along with some platform specific dynamic load libraries like `dl`. With CMake
that burden goes away as `find_package(Boost COMPONENTS dll)` provides a `Boost::dll` target that manages the dependencies to other libraries.
If you want to load a library, just construct [classref boost::dll::shared_library] class with a path to the library as a parameter:
```

2
include/boost/dll/import_class.hpp
View File

@@ -9,7 +9,7 @@
#define BOOST_DLL_IMPORT_CLASS_HPP_
/// \file boost/dll/import_class.hpp
/// \warning Extremely experimental! Requires C++11! Will change in next version of Boost! boost/dll/import_class.hpp is not included in boost/dll.hpp
/// \warning Extremely experimental! May change in next version of Boost! boost/dll/import_class.hpp is not included in boost/dll.hpp
/// \brief Contains the boost::dll::experimental::import_class function for importing classes.
#include <boost/dll/smart_library.hpp>

3
include/boost/dll/import_mangled.hpp
View File

@@ -5,12 +5,11 @@
// (See accompanying file LICENSE_1_0.txt
// or copy at http://www.boost.org/LICENSE_1_0.txt)
#ifndef BOOST_DLL_IMPORT_MANGLED_HPP_
#define BOOST_DLL_IMPORT_MANGLED_HPP_
/// \file boost/dll/import_mangled.hpp
/// \warning Extremely experimental! Requires C++11! Will change in next version of Boost! boost/dll/import_mangled.hpp is not included in boost/dll.hpp
/// \warning Extremely experimental! May change in next version of Boost! boost/dll/import_mangled.hpp is not included in boost/dll.hpp
/// \brief Contains the boost::dll::experimental::import_mangled function for importing mangled symbols.
#include <boost/dll/config.hpp>