diff --git a/Doxyfile b/Doxyfile index 6640b84f57..2bb390bb68 100644 --- a/Doxyfile +++ b/Doxyfile @@ -668,7 +668,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = websocketpp # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -948,13 +948,13 @@ HTML_EXTRA_FILES = # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. # The allowed range is 0 to 359. -HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_HUE = 236 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # the colors in the HTML output. For a value of 0 the output will use # grayscales only. A value of 255 will produce the most vivid colors. -HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_SAT = 0 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # the luminance component of the colors in the HTML output. Values below @@ -963,7 +963,7 @@ HTML_COLORSTYLE_SAT = 100 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, # and 100 does not change the gamma. -HTML_COLORSTYLE_GAMMA = 80 +HTML_COLORSTYLE_GAMMA = 148 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting diff --git a/websocketpp/concurrency/basic.hpp b/websocketpp/concurrency/basic.hpp index e9a2aa6ee7..ed2fb7d606 100644 --- a/websocketpp/concurrency/basic.hpp +++ b/websocketpp/concurrency/basic.hpp @@ -33,6 +33,7 @@ namespace websocketpp { namespace concurrency { +/// Concurrency policy that uses std::mutex / boost::mutex class basic { public: typedef lib::mutex mutex_type; diff --git a/websocketpp/concurrency/none.hpp b/websocketpp/concurrency/none.hpp index 1826b17e20..d5d0b14121 100644 --- a/websocketpp/concurrency/none.hpp +++ b/websocketpp/concurrency/none.hpp @@ -58,6 +58,7 @@ public: } // namespace none_impl +/// Stub Concurrency policy to remove locking in single threaded projects class none { public: typedef none_impl::fake_mutex mutex_type; diff --git a/websocketpp/config/asio.hpp b/websocketpp/config/asio.hpp index 7b794364d4..d0fed07c17 100644 --- a/websocketpp/config/asio.hpp +++ b/websocketpp/config/asio.hpp @@ -39,6 +39,7 @@ namespace websocketpp { namespace config { +/// Server config with asio transport and TLS enabled struct asio_tls : public core { typedef asio_tls type; typedef core base; diff --git a/websocketpp/config/asio_client.hpp b/websocketpp/config/asio_client.hpp index 0c03142ecb..b145940609 100644 --- a/websocketpp/config/asio_client.hpp +++ b/websocketpp/config/asio_client.hpp @@ -39,6 +39,7 @@ namespace websocketpp { namespace config { +/// Client config with asio transport and TLS enabled struct asio_tls_client : public core_client { typedef asio_tls_client type; typedef core_client base; diff --git a/websocketpp/config/asio_no_tls.hpp b/websocketpp/config/asio_no_tls.hpp index 6b7bebe3bd..71e2135485 100644 --- a/websocketpp/config/asio_no_tls.hpp +++ b/websocketpp/config/asio_no_tls.hpp @@ -34,6 +34,7 @@ namespace websocketpp { namespace config { +/// Server config with asio transport and TLS disabled struct asio : public core { typedef asio type; typedef core base; diff --git a/websocketpp/config/asio_no_tls_client.hpp b/websocketpp/config/asio_no_tls_client.hpp index 8f866ff43a..ab80bb0ae0 100644 --- a/websocketpp/config/asio_no_tls_client.hpp +++ b/websocketpp/config/asio_no_tls_client.hpp @@ -34,6 +34,7 @@ namespace websocketpp { namespace config { +/// Client config with asio transport and TLS disabled struct asio_client : public core_client { typedef asio_client type; typedef core_client base; diff --git a/websocketpp/config/core.hpp b/websocketpp/config/core.hpp index db90e2e08c..48e24a9a1f 100644 --- a/websocketpp/config/core.hpp +++ b/websocketpp/config/core.hpp @@ -63,6 +63,7 @@ namespace websocketpp { namespace config { +/// Server config with iostream transport struct core { typedef core type; diff --git a/websocketpp/config/core_client.hpp b/websocketpp/config/core_client.hpp index 777981805c..fb68209ce3 100644 --- a/websocketpp/config/core_client.hpp +++ b/websocketpp/config/core_client.hpp @@ -63,6 +63,7 @@ namespace websocketpp { namespace config { +/// Client config with iostream transport struct core_client { typedef core_client type; diff --git a/websocketpp/config/debug.hpp b/websocketpp/config/debug.hpp index 64b6206e5a..5d9d6bbaed 100644 --- a/websocketpp/config/debug.hpp +++ b/websocketpp/config/debug.hpp @@ -64,6 +64,7 @@ namespace websocketpp { namespace config { +/// Client/Server debug config with iostream transport struct debug_core { typedef debug_core type; diff --git a/websocketpp/config/debug_asio.hpp b/websocketpp/config/debug_asio.hpp index 1545f10a7e..becf5480f2 100644 --- a/websocketpp/config/debug_asio.hpp +++ b/websocketpp/config/debug_asio.hpp @@ -39,6 +39,7 @@ namespace websocketpp { namespace config { +/// Client/Server debug config with asio transport and TLS enabled struct debug_asio_tls : public debug_core { typedef debug_asio_tls type; typedef debug_core base; diff --git a/websocketpp/config/debug_asio_no_tls.hpp b/websocketpp/config/debug_asio_no_tls.hpp index 81c7f40d5b..d9aec66c12 100644 --- a/websocketpp/config/debug_asio_no_tls.hpp +++ b/websocketpp/config/debug_asio_no_tls.hpp @@ -34,6 +34,7 @@ namespace websocketpp { namespace config { +/// Client/Server debug config with asio transport and TLS disabled struct debug_asio : public debug_core { typedef debug_asio type; typedef debug_core base; diff --git a/websocketpp/connection.hpp b/websocketpp/connection.hpp index d43408135c..11e401437c 100644 --- a/websocketpp/connection.hpp +++ b/websocketpp/connection.hpp @@ -113,7 +113,7 @@ namespace internal_state { } // namespace internal_state } // namespace session -// impliments the websocket state machine +/// Represents an individual WebSocket connection template class connection : public config::transport_type::transport_con_type diff --git a/websocketpp/endpoint.hpp b/websocketpp/endpoint.hpp index 63b7579c6c..6e08127472 100644 --- a/websocketpp/endpoint.hpp +++ b/websocketpp/endpoint.hpp @@ -38,7 +38,7 @@ namespace websocketpp { static const char user_agent[] = "WebSocket++/0.3.0dev"; -// creates and manages connections +/// Creates and manages connections associated with a WebSocket endpoint template class endpoint : public config::transport_type, public config::endpoint_base { public: diff --git a/websocketpp/logger/basic.hpp b/websocketpp/logger/basic.hpp index 91b0001f2d..144a00dd19 100644 --- a/websocketpp/logger/basic.hpp +++ b/websocketpp/logger/basic.hpp @@ -49,6 +49,7 @@ namespace websocketpp { namespace log { +/// Basic logger that outputs to an ostream template class basic { public: diff --git a/websocketpp/logger/stub.hpp b/websocketpp/logger/stub.hpp index 41cd30b5b6..4a73c67af6 100644 --- a/websocketpp/logger/stub.hpp +++ b/websocketpp/logger/stub.hpp @@ -35,7 +35,7 @@ namespace websocketpp { namespace log { -/// Stub logger that ignores all input! +/// Stub logger that ignores all input class stub { public: stub(std::ostream* out = &std::cout) {} diff --git a/websocketpp/md5/md5.hpp b/websocketpp/md5/md5.hpp index b06a2be82b..740b382eb3 100644 --- a/websocketpp/md5/md5.hpp +++ b/websocketpp/md5/md5.hpp @@ -70,6 +70,7 @@ #include #include +/// Provides MD5 hashing functionality namespace md5 { typedef unsigned char md5_byte_t; /* 8-bit byte */ diff --git a/websocketpp/processors/hybi13.hpp b/websocketpp/processors/hybi13.hpp index b4ee5f53ed..6231d678f6 100644 --- a/websocketpp/processors/hybi13.hpp +++ b/websocketpp/processors/hybi13.hpp @@ -54,6 +54,7 @@ namespace websocketpp { namespace processor { +/// Processor for Hybi version 13 (RFC6455) template class hybi13 : public processor { public: diff --git a/websocketpp/processors/processor.hpp b/websocketpp/processors/processor.hpp index cde2f58c39..60c62e1555 100644 --- a/websocketpp/processors/processor.hpp +++ b/websocketpp/processors/processor.hpp @@ -153,6 +153,7 @@ uri_ptr get_uri_from_host(request_type & request, std::string scheme) { // } // } +/// WebSocket protocol processor base class template class processor { public: @@ -193,9 +194,9 @@ public: /// validate a WebSocket handshake request for this version /** - * @param r The WebSocket handshake request to validate. - * is_websocket_handshake(r) must be true and get_websocket_version(r) - * must equal this->get_version(). + * @param request The WebSocket handshake request to validate. + * is_websocket_handshake(request) must be true and + * get_websocket_version(request) must equal this->get_version(). * * @return A status code, 0 on success, non-zero for specific sorts of * failure diff --git a/websocketpp/random/none.hpp b/websocketpp/random/none.hpp index c2d3e20fdd..bd740021df 100644 --- a/websocketpp/random/none.hpp +++ b/websocketpp/random/none.hpp @@ -30,6 +30,7 @@ namespace websocketpp { namespace random { +/// Stub RNG policy that always returns 0 namespace none { /// Thread safe stub "random" integer generator. diff --git a/websocketpp/random/random_device.hpp b/websocketpp/random/random_device.hpp index 47d06a7a4c..fec2bb65a5 100644 --- a/websocketpp/random/random_device.hpp +++ b/websocketpp/random/random_device.hpp @@ -32,6 +32,7 @@ namespace websocketpp { namespace random { +/// RNG policy based on std::random_device or boost::random_device namespace random_device { /// Thread safe non-deterministic random integer generator. diff --git a/websocketpp/sha1/sha1.hpp b/websocketpp/sha1/sha1.hpp index 83aeecda50..931f9ddd16 100755 --- a/websocketpp/sha1/sha1.hpp +++ b/websocketpp/sha1/sha1.hpp @@ -30,6 +30,7 @@ namespace websocketpp { +/// Provides SHA1 hashing functionality class SHA1 { public: diff --git a/websocketpp/transport/asio/base.hpp b/websocketpp/transport/asio/base.hpp index f313b916e4..fa260b4fc7 100644 --- a/websocketpp/transport/asio/base.hpp +++ b/websocketpp/transport/asio/base.hpp @@ -38,6 +38,7 @@ namespace websocketpp { namespace transport { +/// Transport policy that uses boost::asio namespace asio { typedef lib::function diff --git a/websocketpp/transport/base/endpoint.hpp b/websocketpp/transport/base/endpoint.hpp index a4ccec0ac0..3d203c2f6d 100644 --- a/websocketpp/transport/base/endpoint.hpp +++ b/websocketpp/transport/base/endpoint.hpp @@ -37,6 +37,7 @@ #include namespace websocketpp { +/// Transport policies provide network connectivity and timers namespace transport { // Endpoint callbacks diff --git a/websocketpp/transport/iostream/base.hpp b/websocketpp/transport/iostream/base.hpp index 6818de4121..c86e8255a6 100644 --- a/websocketpp/transport/iostream/base.hpp +++ b/websocketpp/transport/iostream/base.hpp @@ -35,6 +35,7 @@ namespace websocketpp { namespace transport { +/// Transport policy that uses STL iostream for I/O and does not support timers namespace iostream { namespace error { diff --git a/websocketpp/utf8_validator.hpp b/websocketpp/utf8_validator.hpp index 58b3391628..61ea988406 100644 --- a/websocketpp/utf8_validator.hpp +++ b/websocketpp/utf8_validator.hpp @@ -40,7 +40,8 @@ decode(uint32_t* state, uint32_t* codep, uint8_t byte) { *state = utf8d[256 + *state*16 + type]; return *state; } - + +/// Provides streaming UTF8 validation functionality class validator { public: validator() : m_state(UTF8_ACCEPT),m_codepoint(0) {}