Skip to content

Commit 150a85d

Browse files
committed
docs(sql): add Doxygen comments to version template
Document version.template to achieve 100% documentation coverage: - Add @file tag for version.sql (the generated file) - Document eql_v2.version() function with @brief, @return, @example - Add @note explaining auto-generation from template - Fixes CI validation error for version.template Source: phase-4-doxygen (commits d4c2257, 01ab2f8)
1 parent 4d0698e commit 150a85d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/version.template

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

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

7+
--! @file version.sql
8+
--! @brief EQL version reporting
9+
--!
10+
--! This file is auto-generated from version.template during build.
11+
--! The version string placeholder is replaced with the actual release version.
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 Auto-generated during build from version.template
21+
--!
22+
--! @example
23+
--! -- Check installed EQL version
24+
--! SELECT eql_v2.version();
25+
--! -- Returns: '2.1.0'
726
CREATE FUNCTION eql_v2.version()
827
RETURNS text
928
IMMUTABLE STRICT PARALLEL SAFE

0 commit comments

Comments
 (0)