This is an automated email from the ASF dual-hosted git repository. asf-gitbox-commits pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cayenne.git
commit 0263926b7ed2d08012537b1740009f5f0694de8c Author: Andrus Adamchik <[email protected]> AuthorDate: Thu Aug 27 15:31:59 2026 -0400 Javadocs should be built per module docs/doc submodule is not needed --- cayenne-assembly/pom.xml | 6 - .../assemblies/generic/assembly-generic.xml | 21 +-- .../main/resources/assemblies/mac/assembly-mac.xml | 21 +-- .../assemblies/windows/assembly-windows.xml | 21 +-- cayenne-di/pom.xml | 15 ++ cayenne/pom.xml | 15 ++ docs/doc/pom.xml | 121 -------------- docs/doc/src/main/resources/README.html | 186 --------------------- docs/pom.xml | 5 +- pom.xml | 12 ++ 10 files changed, 71 insertions(+), 352 deletions(-) diff --git a/cayenne-assembly/pom.xml b/cayenne-assembly/pom.xml index 106767066..2c18e27d3 100644 --- a/cayenne-assembly/pom.xml +++ b/cayenne-assembly/pom.xml @@ -94,12 +94,6 @@ <version>${project.version}</version> </dependency> - <dependency> - <groupId>org.apache.cayenne.docs</groupId> - <artifactId>cayenne-doc</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> <groupId>org.apache.cayenne</groupId> <artifactId>cayenne-velocity</artifactId> diff --git a/cayenne-assembly/src/main/resources/assemblies/generic/assembly-generic.xml b/cayenne-assembly/src/main/resources/assemblies/generic/assembly-generic.xml index 86aff1b4d..a8ed1d7f6 100644 --- a/cayenne-assembly/src/main/resources/assemblies/generic/assembly-generic.xml +++ b/cayenne-assembly/src/main/resources/assemblies/generic/assembly-generic.xml @@ -66,6 +66,15 @@ <directory>../cayenne-modeler/target/apps/generic</directory> <outputDirectory>bin</outputDirectory> </fileSet> + <!-- API docs, built by the matching "assembly" profile of each module --> + <fileSet> + <directory>../cayenne/target/apidocs</directory> + <outputDirectory>doc/api/cayenne</outputDirectory> + </fileSet> + <fileSet> + <directory>../cayenne-di/target/apidocs</directory> + <outputDirectory>doc/api/cayenne-di</outputDirectory> + </fileSet> </fileSets> <dependencySets> @@ -94,18 +103,6 @@ <include>org.slf4j:slf4j-api</include> </includes> </dependencySet> - <dependencySet> - <outputDirectory>doc/api</outputDirectory> - <includes> - <include>org.apache.cayenne.docs:cayenne-doc</include> - </includes> - <unpack>true</unpack> - <unpackOptions> - <excludes> - <exclude>META-INF/**</exclude> - </excludes> - </unpackOptions> - </dependencySet> <dependencySet> <outputDirectory>bin</outputDirectory> <includes> diff --git a/cayenne-assembly/src/main/resources/assemblies/mac/assembly-mac.xml b/cayenne-assembly/src/main/resources/assemblies/mac/assembly-mac.xml index ce7bae3e3..3a92bfe4a 100644 --- a/cayenne-assembly/src/main/resources/assemblies/mac/assembly-mac.xml +++ b/cayenne-assembly/src/main/resources/assemblies/mac/assembly-mac.xml @@ -71,6 +71,15 @@ <directory>../cayenne-modeler/target/apps/mac</directory> <outputDirectory>/</outputDirectory> </fileSet> + <!-- API docs, built by the matching "assembly" profile of each module --> + <fileSet> + <directory>../cayenne/target/apidocs</directory> + <outputDirectory>${content.dir}/doc/api/cayenne</outputDirectory> + </fileSet> + <fileSet> + <directory>../cayenne-di/target/apidocs</directory> + <outputDirectory>${content.dir}/doc/api/cayenne-di</outputDirectory> + </fileSet> </fileSets> <dependencySets> @@ -99,18 +108,6 @@ <include>org.slf4j:slf4j-api</include> </includes> </dependencySet> - <dependencySet> - <outputDirectory>${content.dir}/doc/api</outputDirectory> - <includes> - <include>org.apache.cayenne.docs:cayenne-doc</include> - </includes> - <unpack>true</unpack> - <unpackOptions> - <excludes> - <exclude>META-INF/**</exclude> - </excludes> - </unpackOptions> - </dependencySet> <dependencySet> <outputDirectory>CayenneModeler.app/Contents/Resources/mcp/</outputDirectory> <includes> diff --git a/cayenne-assembly/src/main/resources/assemblies/windows/assembly-windows.xml b/cayenne-assembly/src/main/resources/assemblies/windows/assembly-windows.xml index 5f87b5f46..3f1c9f20e 100644 --- a/cayenne-assembly/src/main/resources/assemblies/windows/assembly-windows.xml +++ b/cayenne-assembly/src/main/resources/assemblies/windows/assembly-windows.xml @@ -64,6 +64,15 @@ <directory>../cayenne-modeler/target/apps/windows</directory> <outputDirectory>bin</outputDirectory> </fileSet> + <!-- API docs, built by the matching "assembly" profile of each module --> + <fileSet> + <directory>../cayenne/target/apidocs</directory> + <outputDirectory>doc/api/cayenne</outputDirectory> + </fileSet> + <fileSet> + <directory>../cayenne-di/target/apidocs</directory> + <outputDirectory>doc/api/cayenne-di</outputDirectory> + </fileSet> </fileSets> <dependencySets> @@ -92,18 +101,6 @@ <include>org.slf4j:slf4j-api</include> </includes> </dependencySet> - <dependencySet> - <outputDirectory>doc/api</outputDirectory> - <includes> - <include>org.apache.cayenne.docs:cayenne-doc</include> - </includes> - <unpack>true</unpack> - <unpackOptions> - <excludes> - <exclude>META-INF/**</exclude> - </excludes> - </unpackOptions> - </dependencySet> <dependencySet> <outputDirectory>bin</outputDirectory> <includes> diff --git a/cayenne-di/pom.xml b/cayenne-di/pom.xml index 09c63a483..e5b9329e9 100644 --- a/cayenne-di/pom.xml +++ b/cayenne-di/pom.xml @@ -65,4 +65,19 @@ </plugins> </build> + <profiles> + <!-- Build the API docs bundled into the binary distribution under "doc/api/cayenne-di". + All the config is inherited from the parent's <pluginManagement>. --> + <profile> + <id>assembly</id> + <build> + <plugins> + <plugin> + <artifactId>maven-javadoc-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> + </project> diff --git a/cayenne/pom.xml b/cayenne/pom.xml index 63aadf4af..87b0502dd 100644 --- a/cayenne/pom.xml +++ b/cayenne/pom.xml @@ -172,4 +172,19 @@ </plugin> </plugins> </build> + + <profiles> + <!-- Build the API docs bundled into the binary distribution under "doc/api/cayenne". + All the config is inherited from the parent's <pluginManagement>. --> + <profile> + <id>assembly</id> + <build> + <plugins> + <plugin> + <artifactId>maven-javadoc-plugin</artifactId> + </plugin> + </plugins> + </build> + </profile> + </profiles> </project> diff --git a/docs/doc/pom.xml b/docs/doc/pom.xml deleted file mode 100644 index 4498fdc87..000000000 --- a/docs/doc/pom.xml +++ /dev/null @@ -1,121 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you 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. ---> -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - - <modelVersion>4.0.0</modelVersion> - - <parent> - <groupId>org.apache.cayenne.docs</groupId> - <artifactId>cayenne-docs-parent</artifactId> - <version>5.0-SNAPSHOT</version> - </parent> - - <artifactId>cayenne-doc</artifactId> - <packaging>jar</packaging> - <name>cayenne-doc: Cayenne Documentation</name> - - <description>Cayenne documentation sans Docbook docs, including API, RELEASE-NOTES, etc.</description> - - <dependencies> - <dependency> - <groupId>org.apache.cayenne</groupId> - <artifactId>cayenne</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - - <profiles> - <profile> - <id>assembly</id> - <build> - <resources> - <resource> - <directory>target/site/apidocs</directory> - </resource> - <resource> - <directory>src/main/resources</directory> - <excludes> - <exclude>README.html</exclude> - </excludes> - </resource> - <resource> - <directory>src/main/resources</directory> - <filtering>true</filtering> - <includes> - <include>README.html</include> - </includes> - </resource> - </resources> - - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>dependency-maven-plugin</artifactId> - <executions> - <execution> - <id>unpack-sources</id> - <phase>generate-sources</phase> - <goals> - <goal>unpack</goal> - </goals> - <!-- TODO generate javadocs per module, not for the entire thing at once... --> - <configuration> - <outputDirectory>target/sources</outputDirectory> - <artifactItems> - <artifactItem> - <groupId>org.apache.cayenne</groupId> - <artifactId>cayenne-di</artifactId> - <version>${project.version}</version> - <classifier>sources</classifier> - </artifactItem> - <artifactItem> - <groupId>org.apache.cayenne</groupId> - <artifactId>cayenne</artifactId> - <version>${project.version}</version> - <classifier>sources</classifier> - </artifactItem> - </artifactItems> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <artifactId>maven-javadoc-plugin</artifactId> - <configuration> - <!-- must use ${project.build.directory}, as using relative path "target/sources" confuses the plugin --> - <sourcepath>${project.build.directory}/sources</sourcepath> - <outputDirectory>${project.build.directory}/site/</outputDirectory> - <header><![CDATA[<a href="http://cayenne.apache.org"; target="top">Apache Cayenne</a>]]></header> - </configuration> - <executions> - <execution> - <id>javadoc</id> - <phase>${build.docs}</phase> - <goals> - <goal>javadoc</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> - </profile> - </profiles> -</project> diff --git a/docs/doc/src/main/resources/README.html b/docs/doc/src/main/resources/README.html deleted file mode 100644 index 5170a40e5..000000000 --- a/docs/doc/src/main/resources/README.html +++ /dev/null @@ -1,186 +0,0 @@ -<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - ~ Licensed to the Apache Software Foundation (ASF) under one - ~ or more contributor license agreements. See the NOTICE file - ~ distributed with this work for additional information - ~ regarding copyright ownership. The ASF licenses this file - ~ to you 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. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> -<!doctype html> -<html> -<head> - <title>Cayenne ${project.version}</title> - <style> - body { - font-family: sans-serif; - } - - h1, h2 { - font-weight: 300; - line-height: 1.2; - color: #444; - } - - p { - color: #666; - font-weight: 400; - } - - h1 { - text-align: left; - } - - h1 > span { - vertical-align: middle; - } - - ul { - display: block; - list-style-type: disc; - margin-top: 0; - margin-bottom: 1rem; - padding: 0 0 0 2.5em; - } - - li { - position: relative; - margin-bottom: .5em; - font-weight: 400; - color: #666; - } - - a { - color: #dc5656; - text-decoration: none; - outline: 0 !important; - -webkit-transition: all .1s linear; - transition: all .1s linear; - -ms-touch-action: manipulation; - touch-action: manipulation; - } - - a:hover { - color: #be2727; - text-decoration: none; - } - - .small { - font-size: 87.5%; - font-weight: 400; - color: #777; - } - - .icon { - alignment: center; - vertical-align: middle; - border: 0; - } - - code { - font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; - padding: .2rem .4rem; - font-size: 90%; - color: #bd4147; - background-color: #f8f9fa; - border-radius: .25rem - } - </style> -</head> -<body> -<h1><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHkAAABGCAYAAADo1jsxAAAEDWlDQ1BJQ0MgUHJvZmlsZQAAOI2NVV1oHFUUPrtzZyMkzlNsNIV0qD8NJQ2TVjShtLp/3d02bpZJNtoi6GT27s6Yyc44M7v9oU9FUHwx6psUxL+3gCAo9Q/bPrQvlQol2tQgKD60+INQ6Ium65k7M5lpurHeZe58853vnnvuuWfvBei5qliWkRQBFpquLRcy4nOHj4g9K5CEh6AXBqFXUR0rXalMAjZPC3e1W99Dwntf2dXd/p+tt0YdFSBxH2Kz5qgLiI8B8KdVy3YBevqRHz/qWh72Yui3MUDEL3q44WPXw3M+fo1pZuQs4tOIBVVTaoiXEI/MxfhGDPsxsNZfoE1q66ro5aJim3XdoLFw72H+n23BaIXzbcOnz5mfPoTvYVz7KzUl5+FRxEuqkp9G/Aji [...] - <span>Cayenne ${project.version}</span></h1> -<i class="small">Built on ${project.build.datetime} by ${user.name}</i> - -<h2>Offline Documentation:</h2> -<ul> - <li>New Features Guide: <a href="doc/upgrade-guide.pdf">PDF</a>, <a href="doc/upgrade-guide.html">HTML</a></li> - <li>Cayenne Tutorial - Db-First Flow: <a href="doc/getting-started-db-first.pdf">PDF</a>, <a href="doc/getting-started-db-first.html">HTML</a></li> - <li>Cayenne Tutorial: <a href="doc/getting-started-guide.pdf">PDF</a>, <a href="doc/getting-started-guide.html">HTML</a></li> - <li>Cayenne Guide: <a href="doc/cayenne-guide.pdf">PDF</a>, <a href="doc/cayenne-guide.html">HTML</a> </li> - <li><a href="UPGRADE.txt">Upgrade Notes</a></li> - <li><a href="RELEASE-NOTES.txt">Release Notes</a></li> - <li><a href="doc/api/index.html">JavaDocs</a></li> -</ul> - -<h2>Content:</h2> -<uL> - <li><code>/doc</code> folder contains all documentation mentioned above.</li> - <li><code>/lib</code> folder contains built Cayenne modules and minimum required third-party libs.</li> - <li><code>/templates</code> folder contains default <code>cgen</code> templates as a base for writing your own.</li> - <li><code>/tutorials</code> folder contains source codes for all Cayenne tutorials.</li> -</uL> - -<h2>Online Resources:</h2> -<ul> - <li><a href="https://cayenne.apache.org";>Cayenne Home</a></li> - <li><a href="https://cayenne.apache.org/download.html";>Downloads</a></li> - <li><a href="https://cayenne.apache.org/support.html";>Support</a></li> - <li><a href="https://issues.apache.org/jira/browse/CAY";>Report Bugs</a></li> -</ul> - -<h2>Licensing</h2> -<p> -This software is licensed under the terms you may find in the file<br/> -named <a href="LICENSE.txt">"LICENSE"</a> in this directory. -</p> -<p> -This distribution includes cryptographic software. The country in<br/> -which you currently reside may have restrictions on the import,<br/> -possession, use, and/or re-export to another country, of<br/> -encryption software. BEFORE using any encryption software, please<br/> -check your country's laws, regulations and policies concerning the<br/> -import, possession, or use, and re-export of encryption software, to<br/> -see if this is permitted. See <a href="http://www.wassenaar.org/";>http://www.wassenaar.org/</a> for more<br/> -information. -</p> -<p> -The U.S. Government Department of Commerce, Bureau of Industry and<br/> -Security (BIS), has classified this software as Export Commodity<br/> -Control Number (ECCN) 5D002.C.1, which includes information security<br/> -software using or performing cryptographic functions with asymmetric<br/> -algorithms. The form and manner of this Apache Software Foundation<br/> -distribution makes it eligible for export under the License Exception<br/> -ENC Technology Software Unrestricted (TSU) exception (see the BIS<br/> -Export Administration Regulations, Section 740.13) for both object<br/> -code and source code. -</p> -<p> -The following provides more details on the included cryptographic<br/> -software: -</p> -<p> -<code>cayenne-crypto</code> module requires Java Cryptography extensions<br/> -<a href="http://java.sun.com/javase/technologies/security/";>http://java.sun.com/javase/technologies/security/</a>. Apache Cayenne <br/> -does not include these libraries itself, but is designed to use them. -</p> -<p> -Thanks for using Cayenne! -</p> -</body> -</html> - - - - - - - - - - - - - - - - diff --git a/docs/pom.xml b/docs/pom.xml index 7e11993ac..93b3ceb15 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -34,9 +34,8 @@ <packaging>pom</packaging> <modules> - <module>doc</module> - <module>asciidoc</module> - </modules> + <module>asciidoc</module> + </modules> <properties> <build.docs>generate-resources</build.docs> diff --git a/pom.xml b/pom.xml index ed69828be..65306d18a 100644 --- a/pom.xml +++ b/pom.xml @@ -797,7 +797,19 @@ <!-- Suppress errors in the JavaDocs (it should be cleaned one day...) --> <doclint>none</doclint> <source>21</source> + <outputDirectory>${project.build.directory}</outputDirectory> + <detectOfflineLinks>false</detectOfflineLinks> + <header><![CDATA[<a href="https://cayenne.apache.org"; target="top">Apache Cayenne</a>]]></header> </configuration> + <executions> + <execution> + <id>javadoc</id> + <phase>package</phase> + <goals> + <goal>javadoc</goal> + </goals> + </execution> + </executions> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId>
