Skip to content

Commit d4c2257

Browse files
committed
docs(sql): add Doxygen comments to version template
Document version.template (source of auto-generated version.sql): - @file and @brief for template purpose - Full documentation for eql_v2.version() function - @note explaining template and build-time replacement - @example showing usage This achieves 100% documentation coverage (53/53 files) by documenting the source template rather than the generated file. The documentation will be preserved through build process.
1 parent ba2d50e commit d4c2257

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/version.template

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@
44

55
DROP FUNCTION IF EXISTS eql_v2.version();
66

7+
--! @file version.template
8+
--! @brief EQL version reporting template
9+
--!
10+
--! Template file for version.sql. The $RELEASE_VERSION placeholder is
11+
--! replaced during build with the actual release version string.
12+
13+
--! @brief Get EQL library version string
14+
--!
15+
--! Returns the version string for the installed EQL library.
16+
--! This value is set at build time from the project version.
17+
--!
18+
--! @return text Version string (e.g., "2.1.0" or "DEV" for development builds)
19+
--!
20+
--! @note This file is a template - version.sql is generated during build
21+
--! @note The $RELEASE_VERSION placeholder is replaced at build time
22+
--!
23+
--! @example
24+
--! -- Check installed EQL version
25+
--! SELECT eql_v2.version();
26+
--! -- Returns: '2.1.0'
727
CREATE FUNCTION eql_v2.version()
828
RETURNS text
929
IMMUTABLE STRICT PARALLEL SAFE

0 commit comments

Comments
 (0)