Add package-info.java for documentation clarity (#1334)

nakamura-to · web-flow · commit 6f7e48c78029 · 2025-05-10T10:25:16.000+09:00
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/expr/node/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/expr/node/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.expr.node;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/expr/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/expr/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.expr;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/expr/util/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/expr/util/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.expr.util;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/command/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/command/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.command;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/dao/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/dao/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.dao;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.dialect;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/entity/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/entity/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.entity;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/scalar/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/scalar/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.scalar;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/node/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/node/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.sql.node;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.sql;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/jdbc/util/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/jdbc/util/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.jdbc.util;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/util/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/util/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.util;
diff --git a/doma-core/src/main/java/org/seasar/doma/internal/wrapper/package-info.java b/doma-core/src/main/java/org/seasar/doma/internal/wrapper/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal implementation details for the Doma framework.
+ *
+ * <p>The classes and interfaces in this package are intended solely for the internal implementation
+ * of the Doma framework. They are not part of the public API and may be changed or removed without
+ * notice in future releases. Do not use them directly from external code.
+ */
+package org.seasar.doma.internal.wrapper;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/aggregate/package-info.java b/doma-core/src/main/java/org/seasar/doma/jdbc/aggregate/package-info.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright Doma Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Provides classes and interfaces for entity aggregation and association operations.
+ *
+ * <p>This package contains components for aggregating entities and establishing associations
+ * between them during database operations. Key components include:
+ *
+ * <ul>
+ *   <li>{@link org.seasar.doma.jdbc.aggregate.AggregateCommand} - A command for executing aggregate
+ *       operations on a stream of entities
+ *   <li>{@link org.seasar.doma.jdbc.aggregate.AggregateStrategyType} - A strategy for defining an
+ *       aggregate structure involving a root entity and its associated entities
+ *   <li>{@link org.seasar.doma.jdbc.aggregate.AssociationLinkerType} - Defines how entities are
+ *       linked in an association
+ *   <li>{@link org.seasar.doma.jdbc.aggregate.StreamReducer} - Reduces a stream of entities to a
+ *       result
+ * </ul>
+ */
+package org.seasar.doma.jdbc.aggregate;
diff --git a/doma-core/src/main/java/org/seasar/doma/jdbc/statistic/package-info.java b/doma-core/src/main/java/org/seasar/doma/jdbc/statistic/package-info.java
diff --git a/doma-core/src/main/java/org/seasar/doma/util/package-info.java b/doma-core/src/main/java/org/seasar/doma/util/package-info.java
