Summary
The secrets package implements the Secrets Vault (envelope encryption for API keys, tokens, and other sensitive configuration). Its 3 public interfaces lack Javadoc.
Interfaces to document (3)
src/main/java/ai/labs/eddi/secrets/ISecretProvider.java
src/main/java/ai/labs/eddi/secrets/persistence/ISecretPersistence.java
src/main/java/ai/labs/eddi/secrets/rest/IRestSecretStore.java
How to write good Javadoc
- Read the implementation class to understand what the interface does
- Look at the model class it operates on
- Write 2-3 lines: purpose + what consumes it + key behaviors
Good example (see IConversationMemoryStore):
/**
* Persistence store for conversation memory snapshots.
* Called by the lifecycle pipeline to save/load conversation state
* between turns and across server restarts.
*/
Bad example (don't do this):
Note: If the interface currently has only /** @author ginccc */, replace it with
meaningful Javadoc. Per CONTRIBUTING.md, @author tags are not used in new code.
Acceptance criteria
Summary
The
secretspackage implements the Secrets Vault (envelope encryption for API keys, tokens, and other sensitive configuration). Its 3 public interfaces lack Javadoc.Interfaces to document (3)
src/main/java/ai/labs/eddi/secrets/ISecretProvider.javasrc/main/java/ai/labs/eddi/secrets/persistence/ISecretPersistence.javasrc/main/java/ai/labs/eddi/secrets/rest/IRestSecretStore.javaHow to write good Javadoc
Good example (see
IConversationMemoryStore):Bad example (don't do this):
/** Store for agents. */Acceptance criteria
@authortags are removed./mvnw compilepasses