feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity
Files
f7a0885d17576114f753d390d9d571f22909279b
boost_beast/doc
T
History
Vinnie Falco f7a0885d17 Remove websocket::keep_alive option (API Change): 
fix #332

This removes the keep_alive option from the WebSocket stream.
Callers who wish to control the behavior of the Connection
header may do so in the decorator and completion handlers
for the handshake and accept functions.
2017-07-20 08:12:16 -07:00
..
images
Refactor HTTP identifier names (API Change):
2017-07-20 08:12:13 -07:00
types
New HTTP interfaces (API Change):
2017-07-20 08:12:15 -07:00
.gitignore
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
boostbook.dtd
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
design.qbk
Update copyright dates
2017-07-20 08:12:14 -07:00
Dockerfile
Add documentation building instructions
2017-07-20 08:12:14 -07:00
examples.qbk
Rename to http::dynamic_body, consolidate header:
2017-07-20 08:12:15 -07:00
http.qbk
Fix typo in documentation example
2017-07-20 08:12:15 -07:00
index.xml
Update copyright dates
2017-07-20 08:12:14 -07:00
Jamfile.v2
Update copyright dates
2017-07-20 08:12:14 -07:00
makeqbk.sh
Update copyright dates
2017-07-20 08:12:14 -07:00
master.qbk
New HTTP interfaces (API Change):
2017-07-20 08:12:15 -07:00
overview.qbk
WebSocket doc work
2017-07-20 08:12:16 -07:00
quickref.xml
Remove websocket::keep_alive option (API Change):
2017-07-20 08:12:16 -07:00
README.md
Add documentation building instructions
2017-07-20 08:12:14 -07:00
reference.xsl
Doc XSL support for list and table markdown
2017-07-20 08:12:15 -07:00
source.dox
Rename to BEAST_DOXYGEN
2017-07-20 08:12:15 -07:00
websocket.qbk
WebSocket doc work
2017-07-20 08:12:16 -07:00

README.md

Building documentation

Specifying Files

To specify the source files for which to build documentation, modify INPUT and its related fields in doc/source.dox. Note that the INPUT paths are relative to the doc/ directory.

Install Dependencies

Windows

Install these dependencies:

  1. Install Doxygen
  2. Download the following zip files from xsltproc (Alternate download: ftp://ftp.zlatkovic.com/libxml/), and extract the bin\ folder contents into any folder in your path.
  • iconv
  • libxml2
  • libxslt
  • zlib
  1. Download Boost
  2. Extract the compressed file contents to your (new) $BOOST_ROOT location.
  3. Open a command prompt or shell in the $BOOST_ROOT.
  4. ./bootstrap.bat
  5. If it is not already there, add your $BOOST_ROOT to your environment $PATH.

MacOS

  1. Install doxygen:
  • Use homebrew to install: brew install doxygen. The executable will be installed in /usr/local/bin which is already in your path.
  • Alternatively, install from here: doxygen. You'll then need to make doxygen available to your command line. You can do this by adding a symbolic link from /usr/local/bin to the doxygen executable. For example, $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen
  1. Install Boost
  2. Extract the compressed file contents to your (new) $BOOST_ROOT location.
  3. Open a command prompt or shell in the $BOOST_ROOT.
  4. $ ./bootstrap.bat
  5. If it is not already there, add your $BOOST_ROOT to your environment $PATH. This makes the b2 command available to the command line.
  6. That should be all that's required. In OS X 10.11, at least, libxml2 and libxslt come pre-installed.

Linux

  1. Install Docker
  2. Build Docker image. From the Beast root folder:
sudo docker build -t beast-docs doc/

Do it

Windows & MacOS

From the Beast root folder:

cd doc
./makeqbk.sh && b2

The output will be in doc/html.

Linux

From the Beast root folder:

sudo docker run -v $PWD:/opt/beast --rm beast-docs

The output will be in doc/html.

View Git Blame Copy Permalink