Miscellaneous changes (#78)

* Remove class specifier from LoggerModuleImpl constructor

* Fix usage example in README.md

* Fix doc-strings in views module header

* Set install rules for countly target

Author: borgbyte

CMakeLists.txt

@@ -18,7 +18,15 @@ if (NOT WIN32 AND NOT BUILD_SHARED_LIBS AND NOT COUNTLY_USE_CUSTOM_HTTP)
   message(FATAL_ERROR "You must provide a custom HTTP function when compiling statically.")
 endif()
 
+set(COUNTLY_PUBLIC_HEADERS
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/countly.hpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/countly/constants.hpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/countly/event.hpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/countly/logger_module.hpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/countly/views_module.hpp)
+
 add_library(countly
+  ${COUNTLY_PUBLIC_HEADERS}
   ${CMAKE_CURRENT_SOURCE_DIR}/src/countly.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/src/views_module.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/src/logger_module.cpp
@@ -29,6 +37,7 @@ target_include_directories(countly
   PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src)
 
 set_target_properties(countly PROPERTIES
+    PUBLIC_HEADER "${COUNTLY_PUBLIC_HEADERS}"
     CXX_STANDARD 14
     CXX_STANDARD_REQUIRED YES
     CXX_EXTENSIONS NO)
@@ -101,3 +110,5 @@ if(COUNTLY_BUILD_SAMPLE)
     CXX_STANDARD_REQUIRED YES
     CXX_EXTENSIONS NO)
 endif()
+
+install(TARGETS countly ARCHIVE DESTINATION lib PUBLIC_HEADER DESTINATION include/countly)

README.md

@@ -68,7 +68,7 @@ int main(int argc, char *argv[]) {
 	Countly& ct = Countly::getInstance();
 	// OS, OS_version, device, resolution, carrier, app_version);
 	ct.SetMetrics("Windows 10", "10.22", "Mac", "800x600", "Carrier", "1.0");
-	ct.SetCustomUserDetails({{"Account Type", "Basic"}, {"Employer", "Company4"}});
+	ct.setCustomUserDetails({{"Account Type", "Basic"}, {"Employer", "Company4"}});
 	// Server and port
 	ct.Start("abf2034f975393fa994d1cf8adf9a93e4a29ac29", "https://myserver.com", 403);
 	ct.SetMaxEventsPerMessage(40);

include/countly/views_module.hpp

@@ -15,21 +15,21 @@ class ViewsModule {
   ViewsModule(cly::CountlyDelegates *cly, std::shared_ptr<cly::LoggerModule> logger);
 
   /**
-   * Close view a with id.
+   * Close view with id.
    *
    * @param viewId: id of the view.
    */
   void closeViewWithID(const std::string &viewId);
 
   /**
-   * Close view a with name.
+   * Close view with name.
    *
    * @param name: name of the view.
    */
   void closeViewWithName(const std::string &name);
 
   /**
-   * Close view a with name.
+   * Open view with name.
    *
    * @param name: name of the view.
    * @param segmentation: custom data you want to set.