Merged PR 1477339: Add initial structure for documentation with comme…

…nts on functions

### Does this PR have any customer impact?
No
### Type (Feature, Refactoring, Bugfix, DevOps, Testing, Perf, etc)
Docs
### Does it involve schema level changes? (Table, Column, Index, UDF, etc level changes)
No
### Are you introducing any new config? If yes, do you have tests with and without them being set?
No
### Release Note (Refer [Template](../docs/release_notes/pgmongo_template.md))

### Description

This PR includes updates to add base Doxygen comments within SQL files, setting up initial documentation structure for functions. Additionally, it includes Doxygen configuration files (Doxyfile, etc.) tailored to support SQL file parsing and documentation generation.

----
#### AI description  (iteration 1)
#### PR Classification
Documentation

#### PR Summary
This pull request adds Doxygen comments to various `helio_api` functions to improve code documentation.
- Added Doxygen comments to functions in `sql/udfs/commands_crud/query_cursors_single_page--latest.sql`
- Added Doxygen comments to functions in `sql/udfs/utils/extension_version_utils--latest.sql`
- Added Doxygen comments to functions in `sql/udfs/auth/auth_scram--latest.sql`
- Added Doxygen comments to functions in `sql/udfs/commands_crud/delete--latest.sql`
- Added Doxygen comments to functions in `sql/udfs/schema_mgmt/create_collection_view--latest.sql`

docs/README.md

@@ -0,0 +1,94 @@
+# Generating Documentation with Doxygen
+You can install doxygen using the commands below or [Doxygen website](https://www.doxygen.nl/) to download executable file for Windows. 
+
+
+- **Ubuntu**:  
+  ```bash
+  sudo apt-get install doxygen
+  ```
+
+- **macOS**:  
+  ```bash
+  brew install doxygen
+  ```
+
+
+To generate the documentation, run following in the under the `oss` folder:
+
+```bash
+doxygen Doxyfile
+```
+
+If you want to see logs, you can save them undera log file:
+
+```bash
+doxygen Doxyfile -d 2> doxygen_warnings.log
+```
+
+## Configuration Tips
+Key settings in Doxyfile to be aware of:
+
+- **`INPUT`**: Specifies which directories Doxygen will scan for files to document. Ensure this includes all directories with source files you want in the documentation.
+
+- **`OUTPUT_DIRECTORY`**: Defines where Doxygen will save the generated documentation files. By default, this might be set to docs/html/.
+
+- **`FILTER_PATTERNS`**: This setting allows you to apply specific filters to file types. For example, our configuration applies filter_sql.py to .sql files to enable custom parsing:
+
+- **`HTML_FOOTER`** and **`HTML_HEADER`**: We can use these to add custom HTML headers and footers to each documentation page, which can include elements like a logo, navigation links, or project information.
+
+- **`HTML_STYLESHEET`** and  **`HTML_EXTRA_STYLESHEET`**: We can specify our own CSS file with HTML_STYLESHEET to fully customize the look of the documentation. Alternatively, use HTML_EXTRA_STYLESHEET to add additional styles on top of the default styling.
+
+- **`USE_MDFILE_AS_MAINPAGE`**: Set this to a specific Markdown file (e.g., README.md) if you’d like it to serve as the main page of the documentation.
+
+
+## Viewing the Generated Documentation
+Once Doxygen completes the generation process, you can find the output in the folder specified by `OUTPUT_DIRECTORY`, typically docs/html/. To view the documentation, locate the `index.html` file in `docs/html` directory. Open index.html in your web browser.
+
+
+## Related files
+- **`Doxyfile`**: Controls all settings for Doxygen, including input directories, output formats, and filters.
+
+- **`docs/src/layout.xml`**: Customizes the layout of the generated Doxygen documentation. The base file is auto-generated by Doxygen and in our case, it is only used for defining the headlines of the pages.
+
+- **`docs/src/group_definitions.dox`**: Defines groups in the documentation to organize related code. Currently, the directory name that contains the function is displayed as the group.
+
+- **`docs/src/filter_sql.py`**: A filter script that preprocesses SQL files before Doxygen processes them, enabling custom parsing and schema name replacement. The filter is applied using the `FILTER_PATTERNS` option in the `Doxyfile`, which specifies that the script should run on `.sql` files.
+
+
+```
+FILTER_PATTERNS = *.sql="docs/src/filter_sql.py"
+```
+
+## Doxygen Commenting Guide
+
+Doxygen comments start with `/**` and use tags like `@brief`, `@param`, and `@return` to define different components.
+
+```cpp
+/**
+ * @brief Short summary of the function.
+ * @details Longer description, can span multiple lines.
+ * 
+ * @param[in] paramName Description of the input parameter.
+ * @param[out] outputParam Description of the output parameter.
+ * @param[in,out] inOutParam Parameter used as both input and output.
+ * @return Description of the return value.
+ * @ingroup groupName 
+ */
+```
+
+### Note
+
+If you inspect the `filter_sql.py` file, you'll see that only comments in the `/** */` style are included, while other comment styles are ignored. This approach ensures that only the desired content is documented, helping Doxygen process everything correctly and avoiding issues during documentation generation.
+
+### Common Tags
+
+- **`@brief`**: Short summary of the function or method.
+- **`@details`**: Longer explanation, if needed. It can span multiple lines.
+- **`@param`**: Documents function parameters. Use **`[in]`** for input parameters, **`[out]`** for output parameters, or **`[in,out]`** for parameters that are both input and output.
+- **`@return`**: Describes the return value of the function.
+- **`@ingroup`**: Groups related functions for better organization.
+- **`@warning`**: Warns users about specific issues with the function.
+- **`@deprecated`**: Marks a function as deprecated.
+- **`@note`**: Adds an additional note for context.
+- **`@code` / `@endcode`**: Inserts a code example in the documentation.
+- **`@todo`**: Highlights pending tasks or future improvements.

docs/html/dir_01fc4fa52985fdcbcb64ed2a6013d94b.html

@@ -0,0 +1,106 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.17"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>DocumentDB: test Directory Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">DocumentDB
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.17 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('dir_01fc4fa52985fdcbcb64ed2a6013d94b.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle">
+<div class="title">test Directory Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="subdirs"></a>
+Directories</h2></td></tr>
+<tr class="memitem:dir_e05b7ca118a452a56e45ba541c1c19ea"><td class="memItemLeft" align="right" valign="top">directory &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dir_e05b7ca118a452a56e45ba541c1c19ea.html">regress</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="dir_337651b1623629581d8ff19a83235fcd.html">pg_documentdb</a></li><li class="navelem"><a class="el" href="dir_63d7febf2cc9100e9bebdd4d8ef4c78b.html">src</a></li><li class="navelem"><a class="el" href="dir_01fc4fa52985fdcbcb64ed2a6013d94b.html">test</a></li>
+    <li class="footer">Generated by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
+  </ul>
+</div>
+</body>
+</html>

docs/html/dir_08359bbd050206f277b85d17b8c74a18.html

@@ -0,0 +1,138 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.17"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>DocumentDB: operators Directory Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">DocumentDB
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.17 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('dir_08359bbd050206f277b85d17b8c74a18.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle">
+<div class="title">operators Directory Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
+Files</h2></td></tr>
+<tr class="memitem:bson__dollar__negation__operators--0_816-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_dollar_negation_operators--0.16-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__dollar__operators--0_816-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_dollar_operators--0.16-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__dollar__text__operators--0_824-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_dollar_text_operators--0.24-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__geospatial__operators--0_816-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_geospatial_operators--0.16-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__geospatial__operators--0_818-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_geospatial_operators--0.18-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__gist__geospatial__op__classes--0_816-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_gist_geospatial_op_classes--0.16-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__gist__geospatial__op__classes__members--0_816-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_gist_geospatial_op_classes_members--0.16-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__gist__geospatial__op__classes__members--0_818-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_gist_geospatial_op_classes_members--0.18-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__partial__filter__operators--0_810-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_partial_filter_operators--0.10-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__path__operators--0_810-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_path_operators--0.10-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__path__operators--0_823-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_path_operators--0.23-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__path__operators--0_824-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_path_operators--0.24-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__query__operators--0_810-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_query_operators--0.10-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bson__unique__shard__path__operators--0_824-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bson_unique_shard_path_operators--0.24-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:bsonquery__btree__family--0_810-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>bsonquery_btree_family--0.10-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:operators_2bsonquery__dollar__operators--0_810-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>operators/bsonquery_dollar_operators--0.10-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:shard__key__and__document__operators--0_823-0_8sql"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>shard_key_and_document_operators--0.23-0.sql</b></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="dir_337651b1623629581d8ff19a83235fcd.html">pg_documentdb</a></li><li class="navelem"><a class="el" href="dir_f038498d3e167120203292dbd4cf5213.html">sql</a></li><li class="navelem"><a class="el" href="dir_08359bbd050206f277b85d17b8c74a18.html">operators</a></li>
+    <li class="footer">Generated by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
+  </ul>
+</div>
+</body>
+</html>