Skip to content

Commit 01d8498

Browse files
committed
gpclient: javadoc update
1 parent aed3088 commit 01d8498

8 files changed

Lines changed: 45 additions & 5 deletions

File tree

gpclient/gpclient-core/src/main/java/org/epics/gpclient/datasource/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*/
55

66
/**
7-
* Defines the API to connect data sources to the EPICS General Purpose client (gpclient).
7+
* Defines the API to connect data sources to the EPICS Generic Purpose client.
88
*
99
*/
1010
package org.epics.gpclient.datasource;
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* Copyright information and license terms for this software can be
3+
* found in the file LICENSE.TXT included with the distribution.
4+
*/
5+
/**
6+
* Provides support to use the EPICS Generic Client in JavaFX applications.
7+
*/
8+
package org.epics.gpclient.javafx;
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* Copyright information and license terms for this software can be
3+
* found in the file LICENSE.TXT included with the distribution.
4+
*/
5+
/**
6+
* Provides standard JavaFX tools for the EPICS Generic Client.
7+
*/
8+
package org.epics.gpclient.javafx.tools;

gpclient/gpclient-loc/src/main/java/org/epics/gpclient/loc/package-info.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
* found in the file LICENSE.TXT included with the distribution.
44
*/
55
/**
6-
* Support for a data source that reads and writes channels
7-
* that reside in the local memory (<a href="doc-files/loc-datasource.html">channel syntax</a>).
6+
* Provides support for memory resident data to the EPICS Generic Client.
87
*/
98
package org.epics.gpclient.loc;

gpclient/gpclient-pva/src/main/java/org/epics/gpclient/datasource/pva/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
* found in the file LICENSE.TXT included with the distribution.
44
*/
55
/**
6-
* Support for Epics 4 data source (<a href="doc-files/pva-datasource.html">channel syntax</a>).
6+
* Provides support for PVAccess to the EPICS Generic Client.
77
*/
88
package org.epics.gpclient.datasource.pva;
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* Copyright information and license terms for this software can be
3+
* found in the file LICENSE.TXT included with the distribution.
4+
*/
5+
/**
6+
* Provides examples and tests for the EPICS Generic Client.
7+
*/
8+
package org.epics.gpclient.sample;

gpclient/gpclient-sim/src/main/java/org/epics/gpclient/datasource/sim/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
* found in the file LICENSE.TXT included with the distribution.
44
*/
55
/**
6-
* DataSource for simulated data (<a href="doc-files/sim-datasource.html">channel syntax</a>).
6+
* Provides support for simulated data to the EPICS Generic Client.
77
*/
88
package org.epics.gpclient.datasource.sim;

gpclient/pom.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,23 @@
6868
</plugin>
6969
</plugins>
7070
</build>
71+
<reporting>
72+
<plugins>
73+
<plugin>
74+
<groupId>org.apache.maven.plugins</groupId>
75+
<artifactId>maven-javadoc-plugin</artifactId>
76+
<version>3.0.0</version>
77+
<reportSets>
78+
<reportSet>
79+
<id>aggregate</id>
80+
<reports>
81+
<report>aggregate</report>
82+
</reports>
83+
</reportSet>
84+
</reportSets>
85+
</plugin>
86+
</plugins>
87+
</reporting>
7188
<dependencies>
7289
<dependency>
7390
<groupId>${project.groupId}</groupId>

0 commit comments

Comments
 (0)