Cleaned up a few documentation errors

Change-Id: I30fb5f18d9ad9c7b62c5357ddd55a56ee521eebe
Reviewed-by: Alexei Rousskikh <ext-alexei.rousskikh@nokia.com>

5 files changed, 34 insertions, 6 deletions

diff --git a/src/jsonserver.cpp b/src/jsonserver.cpp
index d6f8537..5a307a3 100644
--- a/src/jsonserver.cpp
+++ b/src/jsonserver.cpp
@@ -105,6 +105,10 @@ inline bool canValidate(JsonServer::ValidatorFlags flags, SchemaValidator *valid
     be enabled separately; there is no general "queue for everyone" setting.
 */
 
+/*!
+  \property JsonServer::validatorFlags
+  The current ValidatorFlags set on this server
+*/
 
 /*!
   Constructs a new JsonServer instance with \a parent.
@@ -438,15 +442,24 @@ void JsonServer::removeConnection(const QString &identifier)
 }
 
 /*!
-     \enum JsonServer::ValidatorFlags
-     \value NoValidation
-         No JSON schema validation of inbound or outbound messages
+     \enum JsonServer::ValidatorFlag
+     This enum determines what the validators do with packets.  The value is
+     specified by combining values from the following list using the bitwise
+     OR operator:
+
      \value DropIfInvalid
          Validate and drop invalid messages.
      \value WarnIfInvalid
          Validate and warn about invalid messages.
      \value ApplyDefaultValues
          If a value is missing then use a default attribute's value fron JSON schema.
+
+     \omitvalue NoValidation
+*/
+
+/*!
+  \fn ValidatorFlags JsonServer::validatorFlags() const
+  Return the current ValidatorFlags
 */
 
 /*!
diff --git a/src/jsonserver.h b/src/jsonserver.h
index f005ec9..63e1cf2 100644
--- a/src/jsonserver.h
+++ b/src/jsonserver.h
@@ -61,6 +61,7 @@ class SchemaValidator;
 class Q_ADDON_JSONSTREAM_EXPORT JsonServer : public QObject
 {
     Q_OBJECT
+    Q_PROPERTY(ValidatorFlags validatorFlags READ validatorFlags WRITE setValidatorFlags)
 
 public:
     JsonServer(QObject *parent = 0);
@@ -88,8 +89,6 @@ public:
     };
     Q_DECLARE_FLAGS(ValidatorFlags, ValidatorFlag)
 
-    Q_PROPERTY(ValidatorFlags validatorFlags READ validatorFlags WRITE setValidatorFlags)
-
     ValidatorFlags validatorFlags() const { return m_validatorFlags; }
     void setValidatorFlags(ValidatorFlags);
 
@@ -133,6 +132,8 @@ private:
     SchemaValidator                       *m_outboundValidator;
 };
 
+Q_DECLARE_OPERATORS_FOR_FLAGS(JsonServer::ValidatorFlags)
+
 QT_END_NAMESPACE_JSONSTREAM
 
 #endif // _JSON_SERVER_H
diff --git a/src/jsonuidrangeauthority.cpp b/src/jsonuidrangeauthority.cpp
index 0530b2c..798be37 100644
--- a/src/jsonuidrangeauthority.cpp
+++ b/src/jsonuidrangeauthority.cpp
@@ -72,6 +72,16 @@ QT_BEGIN_NAMESPACE_JSONSTREAM
  */
 
 /*!
+  \property JsonUIDRangeAuthority::minimum
+  The minimum valid UID.  This must be set to at least 0, or all connections will be refused.
+*/
+
+/*!
+  \property JsonUIDRangeAuthority::maximum
+  The maximum valid UID.  This must be set to at least 0, or all connections will be refused.
+*/
+
+/*!
   Construct a JsonUIDRangeAuthority with optional \a parent.
  */
 
diff --git a/src/qtjsonschema/schemaerror.cpp b/src/qtjsonschema/schemaerror.cpp
index 168bdfe..4d8fc67 100644
--- a/src/qtjsonschema/schemaerror.cpp
+++ b/src/qtjsonschema/schemaerror.cpp
@@ -57,6 +57,10 @@ const QString SchemaError::kMessageStr = QString::fromLatin1("message");
      \omitvalue NoError
      \value FailedSchemaValidation
          Object to be created/updated was invalid according to the schema.
+     \value InvalidSchemaOperation
+         Error somewhere in the schema itself?
+     \value InvalidObject
+         Unable to parse an incoming object
  */
 
 /*!
diff --git a/src/qtjsonschema/schemavalidator.cpp b/src/qtjsonschema/schemavalidator.cpp
index a44253e..a4ea641 100644
--- a/src/qtjsonschema/schemavalidator.cpp
+++ b/src/qtjsonschema/schemavalidator.cpp
@@ -202,7 +202,7 @@ bool SchemaValidator::loadFromFolder(const QString & path, const QString & schem
 }
 
 /*!
-    Supplements a validator object with data from \a filename schema file, using \a type and \a shemaName.
+    Supplements a validator object with data from \a filename schema file, using \a type and \a schemaName.
     Returns true at success, otherwise getLastError() can be used to access
     a detailed error information.
 */