FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix API documentation · patternfly-java/patternfly-java@b1a1827 · GitHub

/ patternfly-java Public

Commit b1a1827

Browse files
hpehl
committed
Fix API documentation
1 parent db13bc8 commit b1a1827

31 files changed

Lines changed: 352 additions & 113 deletions

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
99
### Fixed
1010

1111
- Fix drawer body components
12+
- Fix API documentation
1213

1314
## [0.4.4] - 2026-01-08
1415

‎apidoc/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
src

‎apidoc/pom.xml‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Copyright 2023 Red Hat
5+
6+
Licensed under the Apache License, Version 2.0 (the "License");
7+
you may not use this file except in compliance with the License.
8+
You may obtain a copy of the License at
9+
10+
https://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing, software
13+
distributed under the License is distributed on an "AS IS" BASIS,
14+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
See the License for the specific language governing permissions and
16+
limitations under the License.
17+
18+
-->
19+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
21+
<modelVersion>4.0.0</modelVersion>
22+
23+
<parent>
24+
<groupId>org.patternfly</groupId>
25+
<artifactId>patternfly-java-code-parent</artifactId>
26+
<version>0.4.5-SNAPSHOT</version>
27+
<relativePath>../code-parent/pom.xml</relativePath>
28+
</parent>
29+
30+
<artifactId>patternfly-java-apidoc</artifactId>
31+
<packaging>jar</packaging>
32+
<name>PatternFly Java API</name>
33+
<description>Artificial module containing all sources to build the aggregate PatternFly Java API documentation.
34+
</description>
35+
36+
<dependencies>
37+
<dependency>
38+
<groupId>org.jboss.elemento</groupId>
39+
<artifactId>elemento-svg</artifactId>
40+
</dependency>
41+
</dependencies>
42+
43+
<build>
44+
<plugins>
45+
<plugin>
46+
<groupId>org.apache.maven.plugins</groupId>
47+
<artifactId>maven-clean-plugin</artifactId>
48+
<configuration>
49+
<filesets>
50+
<fileset>
51+
<directory>src</directory>
52+
</fileset>
53+
</filesets>
54+
</configuration>
55+
</plugin>
56+
<plugin>
57+
<groupId>org.apache.maven.plugins</groupId>
58+
<artifactId>maven-antrun-plugin</artifactId>
59+
<inherited>false</inherited>
60+
<executions>
61+
<execution>
62+
<id>copy-sources</id>
63+
<goals>
64+
<goal>run</goal>
65+
</goals>
66+
<configuration>
67+
<target>
68+
<copy todir="src/main/java/org/patternfly" overwrite="true" failonerror="false">
69+
<fileset dir="../charts/src/main/java/org/patternfly/">
70+
<include name="**/*.java"/>
71+
</fileset>
72+
<fileset dir="../components/src/main/java/org/patternfly/">
73+
<include name="**/*.java"/>
74+
</fileset>
75+
<fileset dir="../core/src/main/java/org/patternfly/">
76+
<include name="**/*.java"/>
77+
</fileset>
78+
<fileset dir="../extensions/codeeditor/src/main/java/org/patternfly/">
79+
<include name="**/*.java"/>
80+
</fileset>
81+
<fileset dir="../extensions/finder/src/main/java/org/patternfly/">
82+
<include name="**/*.java"/>
83+
</fileset>
84+
<fileset dir="../icons/src/main/java/org/patternfly/">
85+
<include name="**/*.java"/>
86+
</fileset>
87+
<fileset dir="../layouts/src/main/java/org/patternfly/">
88+
<include name="**/*.java"/>
89+
</fileset>
90+
<fileset dir="../tokens/src/main/java/org/patternfly/">
91+
<include name="**/*.java"/>
92+
</fileset>
93+
</copy>
94+
</target>
95+
</configuration>
96+
</execution>
97+
<execution>
98+
<id>copy-demos</id>
99+
<goals>
100+
<goal>run</goal>
101+
</goals>
102+
<configuration>
103+
<target>
104+
<copy todir="src/demo/java" overwrite="true" failonerror="false">
105+
<fileset dir="../core/src/demo/java">
106+
<include name="**/*.java"/>
107+
</fileset>
108+
<fileset dir="../components/src/demo/java">
109+
<include name="**/*.java"/>
110+
</fileset>
111+
</copy>
112+
</target>
113+
</configuration>
114+
</execution>
115+
</executions>
116+
</plugin>
117+
<plugin>
118+
<groupId>org.apache.maven.plugins</groupId>
119+
<artifactId>maven-javadoc-plugin</artifactId>
120+
<configuration>
121+
<additionalOptions>--snippet-path=${project.basedir}/src/demo/java</additionalOptions>
122+
<debug>true</debug>
123+
<detectLinks>true</detectLinks>
124+
<doclint>none</doclint>
125+
<failOnError>false</failOnError>
126+
<links>
127+
<link>https://hal.github.io/elemento/apidocs/</link>
128+
<link>https://www.gwtproject.org/javadoc/latest/</link>
129+
<link>https://javadoc.io/doc/org.gwtproject.event/gwt-event/${version.gwt.event}/</link>
130+
<link>https://javadoc.io/doc/org.gwtproject.safehtml/gwt-safehtml/${version.gwt.safehtml}/</link>
131+
<link>https://javadoc.io/doc/com.google.elemental2/elemental2-core/${version.elemental2}/</link>
132+
<link>https://javadoc.io/doc/com.google.elemental2/elemental2-dom/${version.elemental2}/</link>
133+
<link>https://javadoc.io/doc/com.google.elemental2/elemental2-promise/${version.elemental2}/</link>
134+
<link>https://javadoc.io/doc/com.google.elemental2/elemental2-webstorage/${version.elemental2}/
135+
</link>
136+
</links>
137+
<show>public</show>
138+
</configuration>
139+
</plugin>
140+
</plugins>
141+
</build>
142+
</project>

‎apidocs.sh‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,12 @@ parse_params() {
9494
parse_params "$@"
9595
setup_colors
9696

97-
./mvnw -Dquickly clean install
98-
./mvnw -P snippets javadoc:aggregate
99-
./mvnw -P snippets javadoc:javadoc
100-
./mvnw -P snippets org.apache.maven.plugins:maven-antrun-plugin:run@copy-apidocs
97+
cd apidocs
98+
mvn clean
99+
mvn org.apache.maven.plugins:maven-antrun-plugin:run@copy-sources
100+
mvn org.apache.maven.plugins:maven-antrun-plugin:run@copy-demos
101+
mvn javadoc:javadoc
102+
103+
cd $script_dir
104+
msg ""
105+
msg "API documentation generated in ${CYAN}apidocs/target/reports/apidocs${NOFORMAT}"

‎components/src/demo/java/ExpandableSectionDemo.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import static org.patternfly.component.expandable.ExpandableSection.expandableSection;
218
import static org.patternfly.component.expandable.ExpandableSectionContent.expandableSectionContent;
319
import static org.patternfly.component.expandable.ExpandableSectionToggle.expandableSectionToggle;
420
import static org.patternfly.layout.stack.Stack.stack;
521
import static org.patternfly.layout.stack.StackItem.stackItem;
622

23+
@SuppressWarnings("unused")
724
public class ExpandableSectionDemo {
825

926
public void detachedDemo() {

‎components/src/demo/java/HasItemsDemo.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import java.util.List;
218

319
import org.patternfly.component.list.DataList;

‎components/src/demo/java/IconDemo.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import java.util.Random;
218

319
import org.patternfly.component.icon.Icon;

‎components/src/demo/java/MenuDemo.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import org.patternfly.component.menu.Menu;
218
import org.patternfly.component.menu.MenuItem;
319
import org.patternfly.component.menu.MenuType;

‎components/src/demo/java/NavigationDemo.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import java.util.List;
218

319
import org.jboss.elemento.Id;

‎components/src/demo/java/PageDemo.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2023 Red Hat
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
import org.patternfly.component.page.MastheadLogo;
218

319
import static org.patternfly.component.page.Masthead.masthead;

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL