You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Document how to generate API documentation with Doxygen
- Explain documentation standards and required tags
- Reference validation tools for quality assurance
- Link to CLAUDE.md for contribution guidelines
- Note automatic CI validation for PRs
This makes documentation generation and standards visible to all users
and contributors.
-[CipherStash integrations using EQL](#cipherstash-integrations-using-eql)
26
27
-[Versioning](#versioning)
27
28
-[Upgrading](#upgrading)
@@ -204,6 +205,49 @@ In order to enable searchable encryption, you will need to configure your Cipher
204
205
- If you are using [CipherStash Proxy](https://github.com/cipherstash/proxy), see [this guide](docs/tutorials/proxy-configuration.md).
205
206
- If you are using [Protect.js](https://github.com/cipherstash/protectjs), use the [Protect.js schema](https://github.com/cipherstash/protectjs/blob/main/docs/reference/schema.md).
206
207
208
+
## Documentation
209
+
210
+
### API Documentation
211
+
212
+
All EQL functions and types are fully documented with Doxygen-style comments in the source code.
213
+
214
+
**Generate API documentation** (requires [Doxygen](https://www.doxygen.nl/)):
215
+
216
+
```bash
217
+
doxygen Doxyfile
218
+
```
219
+
220
+
The generated HTML documentation will be available at `docs/api/html/index.html`.
221
+
222
+
### Documentation Standards
223
+
224
+
All SQL functions, types, and operators include:
225
+
-**@brief** - Short description of purpose
226
+
-**@param** - Parameter descriptions with types
227
+
-**@return** - Return value description and type
228
+
-**@example** - Usage examples
229
+
-**@throws** - Exception conditions
230
+
-**@note** - Important notes and caveats
231
+
232
+
For contribution guidelines, see [CLAUDE.md](./CLAUDE.md).
233
+
234
+
### Validation Tools
235
+
236
+
Verify documentation quality using these scripts:
237
+
238
+
```bash
239
+
# Check documentation coverage (should be 100%)
240
+
./tasks/check-doc-coverage.sh
241
+
242
+
# Validate required Doxygen tags
243
+
./tasks/validate-required-tags.sh
244
+
245
+
# Validate SQL syntax
246
+
./tasks/validate-documented-sql.sh
247
+
```
248
+
249
+
Documentation validation runs automatically in CI for all pull requests.
250
+
207
251
## CipherStash integrations using EQL
208
252
209
253
These frameworks use EQL to enable searchable encryption functionality in PostgreSQL.
0 commit comments