Bug #117299 ddl0bulk.h:236:15: error: parameter 'prebuilt' not found in the function declaration [-Werror,-Wdocumentation]
Submitted: 27 Jan 11:48 Modified: 14 May 15:19
Reporter: Laurynas Biveinis (OCA) Email Updates:
Status: Verified Impact on me:
None 
Category:MySQL Server: Compiling Severity:S3 (Non-critical)
Version:8.4.5, 9.2.0 OS:MacOS (15.2)
Assigned to: CPU Architecture:ARM

[27 Jan 11:48] Laurynas Biveinis
Description:
-DMAINTAINER_MODE=ON and -Wdocumentation being present by default result in:
...
In file included from /Users/laurynas/vilniusdb/mysql-9.2.0/storage/innobase/ddl/ddl0bulk.cc:31:
/Users/laurynas/vilniusdb/mysql-9.2.0/storage/innobase/include/ddl0bulk.h:236:15: error: parameter 'prebuilt' not found in the function declaration [-Werror,-Wdocumentation]
  236 |   @param[in]  prebuilt  prebuilt structures from innodb table handler
      |               ^~~~~~~~

The workarounds are obvious

How to repeat:
-DCMAKE_BUILD_TYPE=Debug -DWITH_DEBUG=ON -DMYSQL_MAINTAINER_MODE=ON -DWITH_SYSTEM_LIBS=ON -DWITH_NDBCLUSTER_STORAGE_ENGINE=OFF -DFORCE_COLORED_OUTPUT=ON -DCMAKE_CXX_FLAGS=-g -DCMAKE_CXX_FLAGS_DEBUG=-g -DCMAKE_CXX_FLAGS_RELEASE=-g -O2 -DNDEBUG

Suggested fix:
Code and comment in question are

  /** Merge the sub-trees to build the cluster index.
  @param[in]  prebuilt  prebuilt structures from innodb table handler
  @return innodb error code. */
  dberr_t merge_subtrees();

The fix is trivial.
[27 Jan 13:15] MySQL Verification Team
Hello Laurynas,

Thank you for the report and feedback.

regards,
Umesh
[14 May 15:19] Laurynas Biveinis
There are -Wdocumentation warnings on 8.4.5 too, e.g.

In file included from /Users/laurynas/vilniusdb/mysql-8.4.5/router/src/harness/src/dynamic_loader.cc:34:
/Users/laurynas/vilniusdb/mysql-8.4.5/router/src/harness/src/../include/mysql/harness/filesystem.h:121:34: error: empty paragraph passed to '@throws' command [-Werror,-Wdocumentation]
  121 |    * @throws std::invalid_argument
      |      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
  122 |    */