Bug#31037561 enable doc-comment warnings for storage/ndb

- enabled doc-comment warnings
- added parameter-names with [[maybe_unused]] to fixed the
  cross-referencing
- removed @return for functions returning void
- fixed @param name
- removed @param that refer to non-existent arguments
- fixed @param[out]

Change-Id: I59bd511c3952d64115e207e1f10af097c0fb51da

Author: weigon

storage/ndb/CMakeLists.txt

@@ -30,8 +30,6 @@ INCLUDE(ndb_add_executable)
 
 MSVC_CPPCHECK_DISABLE()
 DISABLE_MISSING_PROFILE_WARNING()
-# TODO: remove when all -Wdocumentation warnings are fixed.
-DISABLE_DOCUMENTATION_WARNINGS()
 
 IF(NOT WITHOUT_SERVER)
   IF(WIN32)

storage/ndb/include/logger/LogHandler.hpp

@@ -177,7 +177,7 @@ class LogHandler
    *
    * @param config where to store parameters
    */
-  virtual bool getParams(BaseString &/*config*/) {return false;}
+  virtual bool getParams(BaseString &config [[maybe_unused]]) {return false;}
 
   virtual ndb_off_t getCurrentSize() {return -1;}
   virtual ndb_off_t getMaxSize() {return -1;}

storage/ndb/include/mgmapi/mgmapi.h

@@ -1659,7 +1659,7 @@ struct ssl_ctx_st;
    *                        12 if handle is using TLS version 1.2
    *                        13 if handle is using TLS version 1.3
    */
-  int ndb_mgm_has_tls(NdbMgmHandle);
+  int ndb_mgm_has_tls(NdbMgmHandle handle);
 
   /**
    * Struct ndb\_mgm\_cert\_table is a linked structure describing a
@@ -1687,7 +1687,7 @@ struct ssl_ctx_st;
    * On return, list will be populated with a pointer to a table. The table
    * should be freed after use by calling ndb\_mgm\_cert\_table\_free().
    */
-  int ndb_mgm_list_certs(NdbMgmHandle, struct ndb_mgm_cert_table ** list);
+  int ndb_mgm_list_certs(NdbMgmHandle handle, struct ndb_mgm_cert_table ** list);
 
   /**
    * Free a linked list of certificate descriptions.

storage/ndb/plugin/ha_ndbcluster.cc

@@ -1974,7 +1974,7 @@ NDB_INDEX_DATA::Attrid_map::Attrid_map(const KEY *key_info,
 /**
    @brief Create Attrid_map for mapping the columns of KEY to a NDB table.
    @param key_info key to create mapping for
-   @param index NDB table definition
+   @param table NDB table definition
  */
 NDB_INDEX_DATA::Attrid_map::Attrid_map(const KEY *key_info,
                                        const NdbDictionary::Table *table) {

storage/ndb/plugin/ha_ndbcluster_binlog.cc

@@ -6134,7 +6134,7 @@ static inline ndb_binlog_index_row *ndb_find_binlog_index_row(
 /**
    @brief Check that expected columns for specific key are defined
    @param defined               Bitmap of defined (received from NDB) columns
-   @param key                   The key to check columns for
+   @param key_info              The key to check columns for
    @return true if all expected key columns have been recieved
  */
 static bool check_key_defined(MY_BITMAP *defined, const KEY *const key_info) {

storage/ndb/plugin/ha_ndbcluster_binlog.h

@@ -127,7 +127,6 @@ bool ndbcluster_binlog_check_schema_async(const std::string &schema_name);
 /**
  @brief Retrieve information about objects currently excluded from sync
  @param excluded_table  Pointer to excluded objects table object
- @return void
 */
 void ndbcluster_binlog_retrieve_sync_excluded_objects(
     Ndb_sync_excluded_objects_table *excluded_table);
@@ -141,7 +140,6 @@ unsigned int ndbcluster_binlog_get_sync_excluded_objects_count();
 /**
  @brief Retrieve information about objects currently pending sync
  @param pending_table  Pointer to pending objects table object
- @return void
 */
 void ndbcluster_binlog_retrieve_sync_pending_objects(
     Ndb_sync_pending_objects_table *pending_table);

storage/ndb/plugin/ndb_applier.h

@@ -257,7 +257,7 @@ class Ndb_applier {
 
      @param row_server_id   The server_id in the written row
      @param row_epoch       The epoch in the written row
-     @param skip_write[out] Flag telling the caller that write of this row
+     @param[out] skip_write Flag telling the caller that write of this row
                             should be skipped.
      @return 0 for sucess
      @return > 0 for error

storage/ndb/plugin/ndb_replica.h

@@ -199,7 +199,6 @@ class Ndb_replica {
 
     /**
        @brief Get the current max applied epoch for channel
-       @return
      */
     Uint64 get_max_rep_epoch() const {
       std::lock_guard<std::mutex> lock(m_global_mutex);

storage/ndb/src/mgmapi/mgmapi_internal.h

@@ -86,7 +86,6 @@ int ndb_mgm_get_connection_int_parameter(NdbMgmHandle handle,
 /**
  * Convert connection to transporter
  * @param   handle    NDB management handle.
- * @param   s         Transporter socket.
  *
  * @note the socket is now able to be used as a transporter connection
  * @note the management handle is no longer valid after this call

storage/ndb/src/ndbapi/NdbEventOperationImpl.cpp

@@ -476,7 +476,7 @@ NdbEventOperationImpl::get_blob_part_no(bool hasDist)
    data are stored
 
    @param blob           The blob column to print
-   @param event_buf_data Pointer to first event data buffer
+   @param event_data_buf Pointer to first event data buffer
    @param hasDist        Some variability for fuziness
    @param part_start     Number of the first blob part requested
    @param part_count     Count of blob parts requested