Skip to content

Commit 7a1252d

Browse files
committed
build: namespace doxygen tasks under docs:*
1 parent 9f84473 commit 7a1252d

File tree

5 files changed

+8
-9
lines changed

5 files changed

+8
-9
lines changed

.github/workflows/release-eql.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ jobs:
9797
9898
- name: Package documentation
9999
run: |
100-
mise run docs-package ${{ github.event.release.tag_name }}
100+
mise run docs:package ${{ github.event.release.tag_name }}
101101
102102
- name: Upload documentation artifacts
103103
uses: actions/upload-artifact@v4

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ Verify documentation quality:
129129
mise run docs:validate
130130

131131
# Or run individual scripts directly
132-
tasks/check-doc-coverage.sh # Check 100% coverage
133-
tasks/validate-required-tags.sh # Verify @brief, @param, @return tags
134-
tasks/validate-documented-sql.sh # Validate SQL syntax (requires database)
132+
mise run docs:validate:coverage # Check 100% coverage
133+
mise run docs:validate:required-tags # Verify @brief, @param, @return tags
134+
mise run docs:validate:documented-sql # Validate SQL syntax (requires database)
135135
```
136136

137137
### Template Files

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ EXTENSION_MAPPING = sql=C++ template=C++
3939

4040
# CRITICAL: Input filter to convert SQL comments (--!) to C++ style (//!)
4141
# This is REQUIRED for Doxygen to recognize SQL comments
42-
INPUT_FILTER = "tasks/doxygen-filter.sh"
42+
INPUT_FILTER = "tasks/docs/doxygen-filter.sh"
4343
FILTER_SOURCE_FILES = YES
4444

4545
#---------------------------------------------------------------------------
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
2-
# Doxygen input filter for SQL files
3-
# Converts SQL-style comments (--!) to C++-style comments (//!)
2+
#MISE description="Doxygen input filter for SQL files"
43

4+
# Converts SQL-style comments (--!) to C++-style comments (//!)
55
sed 's/^--!/\/\/!/g' "$1"

tasks/docs-package.sh renamed to tasks/docs/package.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
#!/bin/bash
2-
# tasks/docs-package.sh
3-
# Package generated documentation for release
2+
#MISE description="Package documentation for release"
43

54
set -e
65

0 commit comments

Comments
 (0)