mirror of https://github.com/boostorg/beast.git synced 2026-07-06 00:10:58 +02:00

Files

T

Vinnie Falco dc274afcfa Add is_upgrade() free function:

fix #195

This function returns `true` when the passed HTTP Request
indicates a WebSocket Upgrade. It does not validate the
contents of the fields: it just trivially accepts requests
which can only be a WebSocket Upgrade message.

Callers who wish to manually read HTTP requests in their
server implementation can use this function to determine if
the request should be routed to an instance of websocket::stream.

2017-05-05 10:01:18 -07:00

images

Update README.md

2017-05-05 09:54:58 -07:00

types

New HTTP interfaces (API Change):

2017-05-04 18:58:33 -07:00

.gitignore

Beast.WebSocket:

2016-04-20 12:01:24 -04:00

boostbook.dtd

Beast.WebSocket:

2016-04-20 12:01:24 -04:00

design.qbk

Update copyright dates

2017-02-07 15:20:25 -05:00

Dockerfile

Add documentation building instructions

2017-02-07 15:18:42 -05:00

examples.qbk

New HTTP interfaces (API Change):

2017-05-04 18:58:33 -07:00

http.qbk

New HTTP interfaces (API Change):

2017-05-04 18:58:33 -07:00

index.xml

Update copyright dates

2017-02-07 15:20:25 -05:00

Jamfile.v2

Update copyright dates

2017-02-07 15:20:25 -05:00

makeqbk.sh

Update copyright dates

2017-02-07 15:20:25 -05:00

master.qbk

New HTTP interfaces (API Change):

2017-05-04 18:58:33 -07:00

overview.qbk

Update copyright dates

2017-02-07 15:20:25 -05:00

quickref.xml

Add is_upgrade() free function:

2017-05-05 10:01:18 -07:00

README.md

Add documentation building instructions

2017-02-07 15:18:42 -05:00

reference.xsl

Doc XSL support for list and table markdown

2017-04-23 08:26:20 -07:00

source.dox

Rename to BEAST_DOXYGEN

2017-05-04 18:58:33 -07:00

websocket.qbk

New HTTP interfaces (API Change):

2017-05-04 18:58:33 -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:

Install Doxygen
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

Download Boost
Extract the compressed file contents to your (new) $BOOST_ROOT location.
Open a command prompt or shell in the $BOOST_ROOT.
./bootstrap.bat
If it is not already there, add your $BOOST_ROOT to your environment $PATH.

MacOS

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

Install Boost
Extract the compressed file contents to your (new) $BOOST_ROOT location.
Open a command prompt or shell in the $BOOST_ROOT.
$ ./bootstrap.bat
If it is not already there, add your $BOOST_ROOT to your environment $PATH. This makes the b2 command available to the command line.
That should be all that's required. In OS X 10.11, at least, libxml2 and libxslt come pre-installed.

Linux

Install Docker
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.