cleanups

doc/Doxyfile → Doxyfile

@@ -54,7 +54,7 @@ PROJECT_LOGO           =
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = _doxygen
+OUTPUT_DIRECTORY       = ../autobahn-cpp-docs
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -654,7 +654,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../autobahn
+INPUT                  = ../autobahn-cpp/autobahn
 
 # 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
@@ -873,7 +873,7 @@ GENERATE_HTML          = YES
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 # put in front of it. If left blank `html' will be used as the default path.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = docs
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank

README.md

@@ -1,3 +1,14 @@
+Autobahn-C++ allows to create WAMP application components in C++ that can be built as a single,
+statically linked executable with size below 2 MB. Once your component is built, this single
+self contained file has a lot of advantages on the deployment side. However, C++ is also not
+very developer friendly, and the development turnaround can run into the minutes. Compare that with
+the save in editor and "it's live" workflow which is the norm in Web development.
+\n\n
+
+So we hope provides all you need to start creating Autobahn-C++ based client applications
+and WAMP components in C++!
+
+
 # **Autobahn**|Cpp
 
 > This documentation is quite outdated (and also woefully incomplete). When in doubt ask on the [mailing list](https://groups.google.com/forum/#!forum/autobahnws) or read the code!

autobahn/autobahn.hpp

@@ -45,11 +45,51 @@
 #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
 #include "wamp_uds_transport.hpp"
 #endif
-/*! \mainpage Reference Documentation
- *
- * Welcome to the reference documentation of <b>Autobahn</b>|Cpp.<br>
- *
- * For a more gentle introduction, please visit http://autobahn.ws/cpp/.
- */
+
+/*! \mainpage Autobahn-C++ Documentation
+
+Welcome to the [Autobahn-C++](https://github.com/crossbario/autobahn-cpp) documentation.
+\n\n
+
+Autobahn-C++ is a client library for the [WAMP protocol](http://wamp-proto.org/) that
+allows developers to create WAMP application components in C++.
+
+Application components connect to a WAMP router like [Crossbar.io](http://crossbar.io)
+which acts as a messaging layer that allows seamless, secure and cross-language
+communication with other components.
+
+With Autobahn-C++, application components can be (optionally) compiled and linked into
+small (<2MB), single file executables for a specific CPU architecture, and then run
+on all Linux distributions of that architecture.
+
+This comes with a number of deployment, resource efficiency and other advantages.
+\n\n
+
+We provide the documentation here, full working examples and Docker Autobahn-C++ images with
+complete pre-integrated toolchains:
+
+- **[Examples](https://github.com/crossbario/autobahn-cpp/tree/master/examples)**
+- **[Docker toolchain images](https://hub.docker.com/r/crossbario/autobahn-cpp/)**
+
+This should you get started from working code examples that you can gradually modify
+to your needs. All example code is MIT licensed, so you can safely use it in any software
+developement context.
+
+If you have questions, you can reach out at:
+
+- [Mailing list](https://groups.google.com/forum/#!forum/autobahnws)
+- IRC #autobahn on Freenode
+
+If you found a bug in the documentation or have a correction, improvement or addition you
+would like see merged, awesome!
+Please submit an issue or submit a PR directly to the
+Autobahn-C++ source repository
+[here](https://github.com/crossbario/autobahn-cpp), as all the HTML documentation is built from
+comments in the code using Doxygen.
+\n\n
+
+However, if you have a question, please use the mailing list or IRC as mentioned above
+rather than misusing the issue tracker;)
+*/
 
 #endif // AUTOBAHN_HPP

autobahn/wamp_publish_options.hpp

@@ -35,6 +35,10 @@
 
 namespace autobahn {
 
+/*!
+ * \ingroup PUB
+ * Options for publishing.
+ */
 class wamp_publish_options
 {
 public:

autobahn/wamp_session.hpp

@@ -76,6 +76,14 @@ class wamp_unsubscribe_request;
 class wamp_authenticate;
 class wamp_challenge;
 
+/** \defgroup PUB Publishing events
+    \brief Publishing events is done from a session using one of the following functions
+
+When a WAMP session has been established, the session can be used to publish
+event at the router, which in turn will dispatch the event to all eligible and
+authorized subscribes to the topic.
+ */
+
 /// Representation of a WAMP session.
 class wamp_session :
         public wamp_transport_handler,
@@ -132,15 +140,18 @@ class wamp_session :
             const std::string& reason = std::string("wamp.error.close_realm"));
 
     /*!
+     * \ingroup PUB
      * Publish an event with empty payload to a topic.
      *
+     *
      * \param topic The URI of the topic to publish to.
      * \return A future that resolves once the the topic has been published to.
      */
     boost::future<void> publish(const std::string& topic,
                                 const wamp_publish_options& options = wamp_publish_options());
 
     /*!
+     * \ingroup PUB
      * Publish an event with positional payload to a topic.
      *
      * \param topic The URI of the topic to publish to.
@@ -152,6 +163,7 @@ class wamp_session :
                                 const wamp_publish_options& options = wamp_publish_options());
 
     /*!
+     * \ingroup PUB
      * Publish an event with both positional and keyword payload to a topic.
      *
      * \param topic The URI of the topic to publish to.
@@ -259,7 +271,7 @@ class wamp_session :
     virtual boost::future<wamp_authenticate> on_challenge(const wamp_challenge& challenge);
 
     /*!
-    * Accessor method to WELCOME DETAILS dictionary containing router roles 
+    * Accessor method to WELCOME DETAILS dictionary containing router roles
     * and corresponding features, authid, authrole, ...)
     *
     *