Skip to content

Commit a2bd72d

Browse files
BarqawizBarqawiz
committed
fix the java doc documentation and generate plugin details
1 parent adce8b5 commit a2bd72d

File tree

10 files changed

+166
-90
lines changed

10 files changed

+166
-90
lines changed

‎core/com.intellijava.core/pom.xml‎

Lines changed: 46 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -112,63 +112,67 @@
112112
<artifactId>maven-project-info-reports-plugin</artifactId>
113113
<version>3.0.0</version>
114114
</plugin>
115-
<!-- maven publish plugin -->
116-
<plugin>
117-
<groupId>org.sonatype.plugins</groupId>
118-
<artifactId>nexus-staging-maven-plugin</artifactId>
119-
<version>1.6.7</version>
120-
<extensions>true</extensions>
121-
<configuration>
122-
<serverId>ossrh</serverId>
123-
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
124-
<autoReleaseAfterClose>true</autoReleaseAfterClose>
125-
</configuration>
126-
</plugin>
127-
<!-- java doc generation -->
128-
<plugin>
115+
116+
</plugins>
117+
</pluginManagement>
118+
119+
<plugins>
120+
<!-- GPG Signed Components -->
121+
<plugin>
129122
<groupId>org.apache.maven.plugins</groupId>
130-
<artifactId>maven-source-plugin</artifactId>
131-
<version>2.2.1</version>
123+
<artifactId>maven-gpg-plugin</artifactId>
124+
<version>1.5</version>
132125
<executions>
133126
<execution>
134-
<id>attach-sources</id>
127+
<id>sign-artifacts</id>
128+
<phase>verify</phase>
135129
<goals>
136-
<goal>jar-no-fork</goal>
130+
<goal>sign</goal>
137131
</goals>
138132
</execution>
139133
</executions>
140134
</plugin>
135+
<!-- maven publish plugin -->
141136
<plugin>
142-
<groupId>org.apache.maven.plugins</groupId>
143-
<artifactId>maven-javadoc-plugin</artifactId>
144-
<version>2.9.1</version>
145-
<executions>
137+
<groupId>org.sonatype.plugins</groupId>
138+
<artifactId>nexus-staging-maven-plugin</artifactId>
139+
<version>1.6.12</version>
140+
<extensions>true</extensions>
141+
<configuration>
142+
<serverId>ossrh</serverId>
143+
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
144+
<autoReleaseAfterClose>true</autoReleaseAfterClose>
145+
</configuration>
146+
</plugin>
147+
<!-- sources -->
148+
<plugin>
149+
<groupId>org.apache.maven.plugins</groupId>
150+
<artifactId>maven-source-plugin</artifactId>
151+
<version>3.2.1</version>
152+
<executions>
153+
<execution>
154+
<id>attach-sources</id>
155+
<phase>verify</phase>
156+
<goals>
157+
<goal>jar-no-fork</goal>
158+
</goals>
159+
</execution>
160+
</executions>
161+
</plugin>
162+
<!-- java doc -->
163+
<plugin>
164+
<groupId>org.apache.maven.plugins</groupId>
165+
<artifactId>maven-javadoc-plugin</artifactId>
166+
<version>3.4.1</version>
167+
<executions>
146168
<execution>
147169
<id>attach-javadocs</id>
148170
<goals>
149171
<goal>jar</goal>
150172
</goals>
151173
</execution>
152174
</executions>
153-
</plugin>
154-
<!-- GPG Signed Components -->
155-
<!-- TODO: generate GPG keys and back to: https://central.sonatype.org/publish/publish-maven/ -->
156-
<!-- https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key -->
157-
<plugin>
158-
<groupId>org.apache.maven.plugins</groupId>
159-
<artifactId>maven-gpg-plugin</artifactId>
160-
<version>1.5</version>
161-
<executions>
162-
<execution>
163-
<id>sign-artifacts</id>
164-
<phase>verify</phase>
165-
<goals>
166-
<goal>sign</goal>
167-
</goals>
168-
</execution>
169-
</executions>
170-
</plugin>
171-
</plugins>
172-
</pluginManagement>
175+
</plugin>
176+
</plugins>
173177
</build>
174178
</project>

‎core/com.intellijava.core/src/main/java/com/intellijava/core/model/BaseRemoteModel.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@
2424
public abstract class BaseRemoteModel {
2525
private String id;
2626

27+
/**
28+
* BaseRemoteModel default constructor.
29+
*/
30+
public BaseRemoteModel() {
31+
32+
}
33+
2734
/**
2835
* Get the id of the model
2936
*

‎core/com.intellijava.core/src/main/java/com/intellijava/core/model/OpenaiImageResponse.java‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
* The class contains a nested call Data
1010
*
11-
* @author barqawi
11+
* @author github.com/Barqawiz
1212
*/
1313
public class OpenaiImageResponse extends BaseRemoteModel {
1414

@@ -17,12 +17,26 @@ public class OpenaiImageResponse extends BaseRemoteModel {
1717

1818

1919
private List<Data> data;
20+
21+
/**
22+
* OpenaiImageResponse default constructor.
23+
*/
24+
public OpenaiImageResponse() {
25+
26+
}
2027

2128
/**
2229
* A nested class that represents an image object returned in the API response.
2330
*/
2431
public static class Data {
2532
private String url;
33+
34+
/**
35+
* Data default constructor.
36+
*/
37+
public Data() {
38+
39+
}
2640

2741
/**
2842
* Gets the URL of the image

‎core/com.intellijava.core/src/main/java/com/intellijava/core/model/OpenaiLanguageResponse.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ public class OpenaiLanguageResponse extends BaseRemoteModel {
3232
private List<Choice> choices;
3333
private Usage usage;
3434

35+
/**
36+
* OpenaiLanguageResponse default constructor.
37+
*/
38+
public OpenaiLanguageResponse() {
39+
40+
}
41+
3542
/**
3643
* A nested class that represents an choice object returned in the API response.
3744
*/
@@ -44,6 +51,13 @@ public static class Choice {
4451
private Object logprobs;
4552
private String finish_reason;
4653

54+
/**
55+
* Choice default constructor.
56+
*/
57+
public Choice() {
58+
59+
}
60+
4761
/**
4862
* Get the text property of the choice object
4963
*
@@ -119,6 +133,14 @@ public static class Usage {
119133
private int prompt_tokens;
120134
private int completion_tokens;
121135
private int total_tokens;
136+
137+
/**
138+
* Usage default constructor.
139+
*/
140+
public Usage() {
141+
142+
}
143+
122144
/**
123145
* Get the prompt_tokens property
124146
*

‎core/com.intellijava.core/src/main/java/com/intellijava/core/model/input/ImageModelInput.java‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ public class ImageModelInput {
2929
private String imageSize;
3030

3131
/**
32-
* Private Constructor for the Builder
33-
* @param builder: instance of Builder
32+
* Private Constructor for the Builder.
33+
* @param builder instance of Builder
3434
*/
3535
private ImageModelInput(Builder builder) {
3636
this.prompt = builder.prompt;
@@ -46,7 +46,8 @@ public static class Builder {
4646
private int numberOfImages;
4747
private String imageSize;
4848
/**
49-
* Constructor
49+
* Image input Constructor.
50+
* @param prompt : the text of the required action or the question.
5051
*/
5152
public Builder(String prompt) {
5253
this.prompt = prompt;
@@ -55,7 +56,7 @@ public Builder(String prompt) {
5556
/**
5657
* Setter for prompt
5758
* @param prompt : the text of the required action or the question.
58-
* @return: instance of Builder
59+
* @return instance of Builder
5960
*/
6061
public Builder setPrompt(String prompt) {
6162
this.prompt = prompt;
@@ -65,7 +66,7 @@ public Builder setPrompt(String prompt) {
6566
/**
6667
* Setter for numberOfImages
6768
* @param numberOfImages : the number of the generated images.
68-
* @return: instance of Builder
69+
* @return instance of Builder
6970
*/
7071
public Builder setNumberOfImages(int numberOfImages) {
7172
this.numberOfImages = numberOfImages;
@@ -75,40 +76,40 @@ public Builder setNumberOfImages(int numberOfImages) {
7576
/**
7677
* Setter for imageSize
7778
* @param imageSize : the size of the generated images, options are: 256x256, 512x512, or 1024x1024.
78-
* @return: instance of Builder
79+
* @return instance of Builder
7980
*/
8081
public Builder setImageSize(String imageSize) {
8182
this.imageSize = imageSize;
8283
return this;
8384
}
8485

8586
/**
86-
* Build the final ImageModelInput object
87-
* @return: final ImageModelInput object
87+
* Build the final ImageModelInput object.
88+
* @return final ImageModelInput object
8889
*/
8990
public ImageModelInput build() {
9091
return new ImageModelInput(this);
9192
}
9293
}
9394
/**
94-
* Getter for prompt
95-
* @return: prompt
95+
* Getter for prompt.
96+
* @return prompt
9697
*/
9798
public String getPrompt() {
9899
return prompt;
99100
}
100101

101102
/**
102-
* Getter for numberOfImages
103-
* @return: numberOfImages
103+
* Getter for numberOfImages.
104+
* @return numberOfImages
104105
*/
105106
public int getNumberOfImages() {
106107
return numberOfImages;
107108
}
108109

109110
/**
110-
* Getter for imageSize
111-
* @return: imageSize
111+
* Getter for imageSize.
112+
* @return imageSize
112113
*/
113114
public String getImageSize() {
114115
return imageSize;

0 commit comments

Comments
 (0)