Skip to content

docs: add Javadoc to secrets package interfaces #547

Description

@ginccc

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

  1. Read the implementation class to understand what the interface does
  2. Look at the model class it operates on
  3. 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):

/** Store for agents. */

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

  • All 3 interfaces have class-level Javadoc
  • Any existing @author tags are removed
  • ./mvnw compile passes

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: XSTrivial: under 30 min, 1-3 lines, single file

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions