Add ApiDocs.

Author: lganzzzo

src/oatpp-postgresql/Connection.hpp

@@ -33,9 +33,16 @@
 
 namespace oatpp { namespace postgresql {
 
+/**
+ * Implementation of &id:oatpp::orm::Connection; for PostgreSQL.
+ */
 class Connection : public orm::Connection {
 public:
 
+  /**
+   * Get PostgreSQL native connection handle.
+   * @return
+   */
   virtual PGconn* getHandle() = 0;
 
   virtual void setPrepared(const oatpp::String& statementName) = 0;

src/oatpp-postgresql/Executor.hpp

@@ -39,6 +39,9 @@
 
 namespace oatpp { namespace postgresql {
 
+/**
+ * Implementation of &id:oatpp::orm::Executor;. for PostgreSQL.
+ */
 class Executor : public orm::Executor {
 private:
 

src/oatpp-postgresql/QueryResult.hpp

@@ -32,6 +32,10 @@
 
 namespace oatpp { namespace postgresql {
 
+
+/**
+ * Implementation of &id:oatpp::orm::QueryResult;. for PostgreSQL.
+ */
 class QueryResult : public orm::QueryResult {
 private:
   static constexpr v_int32 TYPE_ERROR = 0;

src/oatpp-postgresql/mapping/Deserializer.hpp

@@ -32,6 +32,9 @@
 
 namespace oatpp { namespace postgresql { namespace mapping {
 
+/**
+ * Mapper from PostgreSQL values to oatpp values.
+ */
 class Deserializer {
 public:
 

src/oatpp-postgresql/mapping/Oid.hpp

@@ -22,6 +22,11 @@
  *
  ***************************************************************************/
 
+/**[info]
+ *
+ * A copy-pasted table of postgresql OIDs.
+ */
+
 #ifndef oatpp_postgresql_mapping_Oid_hpp
 #define oatpp_postgresql_mapping_Oid_hpp
 

src/oatpp-postgresql/mapping/ResultMapper.hpp

@@ -32,21 +32,57 @@
 
 namespace oatpp { namespace postgresql { namespace mapping {
 
+/**
+ * Mapper from PostgreSQL result to oatpp objects.
+ */
 class ResultMapper {
 public:
 
+  /**
+   * Result data.
+   */
   struct ResultData {
 
+    /**
+     * Constructor.
+     * @param pDbResult
+     * @param pTypeResolver
+     */
     ResultData(PGresult* pDbResult, const std::shared_ptr<const data::mapping::TypeResolver>& pTypeResolver);
 
+    /**
+     * PGResult.
+     */
     PGresult* dbResult;
 
+    /**
+     * &id:oatpp::data::mapping::TypeResolver;.
+     */
     std::shared_ptr<const data::mapping::TypeResolver> typeResolver;
 
+    /**
+     * Column names.
+     */
     std::vector<oatpp::String> colNames;
+
+    /**
+     * Column indices.
+     */
     std::unordered_map<data::share::StringKeyLabel, v_int32> colIndices;
+
+    /**
+     * Column count.
+     */
     v_int64 colCount;
+
+    /**
+     * Current row index.
+     */
     v_int64 rowIndex;
+
+    /**
+     * Row count.
+     */
     v_int64 rowCount;
 
   };
@@ -129,12 +165,55 @@ class ResultMapper {
   std::vector<ReadRowsMethod> m_readRowsMethods;
 public:
 
+  /**
+   * Default constructor.
+   */
   ResultMapper();
 
+  /**
+   * Set "read one row" method for class id.
+   * @param classId
+   * @param method
+   */
   void setReadOneRowMethod(const data::mapping::type::ClassId& classId, ReadOneRowMethod method);
+
+  /**
+   * Set "read rows" method for class id.
+   * @param classId
+   * @param method
+   */
   void setReadRowsMethod(const data::mapping::type::ClassId& classId, ReadRowsMethod method);
 
+  /**
+   * Read one row to oatpp object or collection. <br>
+   * Allowed output type classes are:
+   *
+   * - &id:oatpp::Vector;
+   * - &id:oatpp::List;
+   * - &id:oatpp::UnorderedSet;
+   * - &id:oatpp::Fields;
+   * - &id:oatpp::UnorderedFields;
+   * - &id:oatpp::Object;
+   *
+   * @param dbData
+   * @param type
+   * @return
+   */
   oatpp::Void readOneRow(ResultData* dbData, const Type* type, v_int64 rowIndex);
+
+  /**
+   * Read `count` of rows to oatpp collection. <br>
+   * Allowed collections to store rows are:
+   *
+   * - &id:oatpp::Vector;
+   * - &id:oatpp::List;
+   * - &id:oatpp::UnorderedSet;.
+   *
+   * @param dbData
+   * @param type
+   * @param count
+   * @return
+   */
   oatpp::Void readRows(ResultData* dbData, const Type* type, v_int64 count);
 
 };

src/oatpp-postgresql/mapping/Serializer.hpp

@@ -31,6 +31,9 @@
 
 namespace oatpp { namespace postgresql { namespace mapping {
 
+/**
+ * Mapper of oatpp values to PostgreSQL values.
+ */
 class Serializer {
 public:
 

src/oatpp-postgresql/mapping/type/Uuid.hpp

@@ -78,6 +78,9 @@ class UuidObject {
 
 };
 
+/**
+ * UUID type to store UUID data.
+ */
 typedef oatpp::data::mapping::type::Primitive<UuidObject, __class::Uuid> Uuid;
 
 namespace __class {

src/oatpp-postgresql/orm.hpp

@@ -22,6 +22,20 @@
  *
  ***************************************************************************/
 
+/**[info]
+ *
+ * This is just a header file which includes all oatpp-postgresql components:
+ *
+ * ```cpp
+ * #include "Executor.hpp"
+ * #include "Types.hpp"
+ *
+ * #include "oatpp/orm/SchemaMigration.hpp"
+ * #include "oatpp/orm/DbClient.hpp"
+ * #include "oatpp/core/macro/codegen.hpp"
+ * ```
+ */
+
 #ifndef oatpp_postgresql_orm_hpp
 #define oatpp_postgresql_orm_hpp
 

src/oatpp-postgresql/ql_template/Parser.hpp

@@ -32,14 +32,35 @@
 
 namespace oatpp { namespace postgresql { namespace ql_template {
 
+/**
+ * Query template parser.
+ */
 class Parser {
 public:
 
+  /**
+   * Query template extra info.
+   */
   struct TemplateExtra {
 
+    /**
+     * Query template name.
+     */
     oatpp::String templateName;
+
+    /**
+     * Template text with parameters substituted to SQLite parameter placeholders.
+     */
     oatpp::String preparedTemplate;
+
+    /**
+     * Parameter type map.
+     */
     orm::Executor::ParamsTypeMap paramsTypeMap;
+
+    /**
+     * Use prepared statement for this query.
+     */
     bool prepare;
 
   };
@@ -51,6 +72,11 @@ class Parser {
   static void skipStringInDollars(parser::Caret& caret);
 public:
 
+  /**
+   * Parse query template.
+   * @param text
+   * @return - &id:oatpp::data::share::StringTemplate;.
+   */
   static data::share::StringTemplate parseTemplate(const oatpp::String& text);
 
 };