Summary
Continuation of interface Javadoc coverage for the configs package.
Interfaces to document (8)
src/main/java/ai/labs/eddi/configs/channels/IChannelIntegrationStore.java
src/main/java/ai/labs/eddi/configs/deployment/IDeploymentStore.java
src/main/java/ai/labs/eddi/configs/descriptors/IDocumentDescriptorStore.java
src/main/java/ai/labs/eddi/configs/propertysetter/IPropertySetterStore.java
src/main/java/ai/labs/eddi/configs/snippets/IPromptSnippetStore.java
src/main/java/ai/labs/eddi/configs/rag/IRagStore.java
src/main/java/ai/labs/eddi/configs/properties/IUserMemoryStore.java
src/main/java/ai/labs/eddi/configs/groups/IAgentGroupStore.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
Continuation of interface Javadoc coverage for the
configspackage.Interfaces to document (8)
src/main/java/ai/labs/eddi/configs/channels/IChannelIntegrationStore.javasrc/main/java/ai/labs/eddi/configs/deployment/IDeploymentStore.javasrc/main/java/ai/labs/eddi/configs/descriptors/IDocumentDescriptorStore.javasrc/main/java/ai/labs/eddi/configs/propertysetter/IPropertySetterStore.javasrc/main/java/ai/labs/eddi/configs/snippets/IPromptSnippetStore.javasrc/main/java/ai/labs/eddi/configs/rag/IRagStore.javasrc/main/java/ai/labs/eddi/configs/properties/IUserMemoryStore.javasrc/main/java/ai/labs/eddi/configs/groups/IAgentGroupStore.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