docs: enhance documentation at entties

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
jakartaee · Feb 11, 2025 · 1b25bbd · 1b25bbd
1 parent 3a16115
commit 1b25bbd
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 110 deletions.
diff --git a/tck/README.adoc b/tck/README.adoc
diff --git a/tck/src/main/java/ee/jakarta/tck/nosql/entities/package-info.java b/tck/src/main/java/ee/jakarta/tck/nosql/entities/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+/**
+ * This package contains entity classes and converters for use in Jakarta NoSQL TCK tests.
+ * The entities represent domain models used to validate Jakarta NoSQL implementations,
+ * while converters handle type transformations where necessary.
+ * These classes support testing CRUD operations, queries, and annotation behavior
+ * across different NoSQL databases.
+ */
+package ee.jakarta.tck.nosql.entities;