improved documentation

Author: Koen Deforche

doc/main

@@ -12,7 +12,7 @@
 
 namespace Wt {
 
-/*! \class WException Wt/Exception
+/*! \class WException Wt/WException
  *  \brief Base class for exceptions thrown by %Wt.
  */
 class WT_API WException : public std::exception

src/Wt/WException

@@ -325,7 +325,22 @@ private:
   friend class WLogger;
 };
 
+#ifdef DOXYGEN_ONLY
+/*! \file */
+/*! \brief Logging function
+ *
+ * This creates a new log entry, e.g.:
+ *
+ * \code
+ * Wt::log("info") << "Doing something interesting now with " << appleCount() << " apples.";
+ * \endcode
+ *
+ * \relates WLogger
+ */
+extern WLogEntry log(const std::string& type);
+#else
 WT_API extern WLogEntry log(const std::string& type);
+#endif
 
 }
 

src/Wt/WLogger

@@ -9,6 +9,7 @@
 
 #include <iostream>
 #include <string>
+#include <signal.h>
 
 #include "Configuration.h"
 #include "FCGIStream.h"

src/fcgi/WServer.C

@@ -1139,6 +1139,7 @@ void WebRenderer::serveMainAjax(WebResponse& response)
 
 void WebRenderer::setJSSynced(bool invisibleToo)
 {
+  LOG_DEBUG("setJSSynced: " << invisibleToo);
   collectedJS1_.str("");
   collectedJS2_.str("");
 

src/web/WebRenderer.C

@@ -1567,8 +1567,10 @@ std::string WebSession::ajaxCanonicalUrl(const WebResponse& request) const
 
 void WebSession::pushUpdates()
 {
-  if (!renderer_.isDirty() || state_ == Dead)
+  if (!renderer_.isDirty() || state_ == Dead) {
+    LOG_DEBUG("pushUpdates(): nothing to do");
     return;
+  }
 
   updatesPending_ = true;
 
@@ -1868,7 +1870,8 @@ void WebSession::notify(const WEvent& event)
 	   */
 	  const std::string *ackIdE = request.getParameter("ackId");
 	  bool invalidAckId = env_->ajax() && !request.isWebSocketMessage(); 
-	  if (ackIdE) {
+
+	  if (invalidAckId && ackIdE) {
 	    try {
 	      if (renderer_.ackUpdate(boost::lexical_cast<unsigned>(*ackIdE)))
 		invalidAckId = false;

src/web/WebSession.C

@@ -337,7 +337,7 @@
 
 	<!-- Enables web socket.
 
-	   By default AJAX and long polling are used to communicate
+	   By default Ajax and long polling are used to communicate
 	   between server and browser.
 
            By enabling web socket support, if the browser supports
@@ -351,9 +351,8 @@
            for this protocol.
 
            This feature is still experimental: the Web Sockets RFC is
-           still a draft with ongoing changes to the framing protocol,
-	   and the current implementation is based on
-	   http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00
+           still a draft. Wt implements up to version 17 of the draft
+	   (latest as of November 2011).
 	  -->
 	<web-sockets>false</web-sockets>
 
@@ -400,21 +399,21 @@
 	<!-- Ajax user agent list
 
            Wt considers three types of sessions:
-	   - AJAX sessions: use AJAX and JavaScript
+	   - Ajax sessions: use Ajax and JavaScript
 	   - plain HTML sessions: use plain old server GETs and POSTs
 	   - bots: have clean internal paths and no persistent sessions
 
            By default, Wt does a browser detection to distinguish between
 	   the first two: if a browser supports JavaScript (and has it
-	   enabled), and has an AJAX DOM API, then AJAX sessions are chosen,
+	   enabled), and has an Ajax DOM API, then Ajax sessions are chosen,
 	   otherwise plain HTML sessions.
 
            Here, you may indicate which user agents should or should
-           not receive an AJAX session regardless of what they report as
+           not receive an Ajax session regardless of what they report as
 	   capabilities.
 
            Possible values for 'mode' or "white-list" or "black-list". A
-	   white-list will only treat the listed agents as supporting AJAX,
+	   white-list will only treat the listed agents as supporting Ajax,
 	   all other agents will be served plain HTML sessions. A black-list
 	   will always server plain HTML sessions to listed agents and
 	   otherwise rely on browser capability detection.
@@ -444,11 +443,11 @@
 
 	<!-- Whether the progressive bootstrap is used.
 
-	   The default bootstrap method first senses whether there is AJAX
+	   The default bootstrap method first senses whether there is Ajax
 	   support, and only then creates the application.
 
 	   The progressive bootstrap method first renders a plain HTML
-	   version and later upgrades to an AJAX version.
+	   version and later upgrades to an Ajax version.
 	  -->
 	<progressive-bootstrap>false</progressive-bootstrap>