Skip to content

Commit 0a2331f

Browse files
committed
update javadoc documentation
1 parent c4a89b8 commit 0a2331f

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ private ImageModelInput(Builder builder) {
4242
/**
4343
* ImageModelInput default constructor.
4444
*
45-
* @param prompt
46-
* @param numberOfImages
47-
* @param imageSize
45+
* @param prompt image generation text.
46+
* @param numberOfImages number of generated images.
47+
* @param imageSize size of the generated images, options are: 256x256, 512x512, or 1024x1024.
4848
*/
4949
public ImageModelInput(String prompt, int numberOfImages, String imageSize) {
5050
super();

core/com.intellijava.core/src/main/java/com/intellijava/core/model/input/LanguageModelInput.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ private LanguageModelInput(Builder builder) {
3535
/**
3636
* LanguageModelInput default constructor.
3737
*
38-
* @param model
39-
* @param prompt
40-
* @param temperature
41-
* @param maxTokens
42-
* @param numberOfOutputs
38+
* @param model name.
39+
* @param prompt text.
40+
* @param temperature model creativity between 0 and 1.
41+
* @param maxTokens number of input and output tokens.
42+
* @param numberOfOutputs number of generated text.
4343
*/
4444
public LanguageModelInput(String model, String prompt, float temperature, int maxTokens, int numberOfOutputs) {
4545
super();

core/com.intellijava.core/src/main/java/com/intellijava/core/utils/AudioHelper.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public AudioHelper() {}
3232
*
3333
* decode base64 audio string and convert to audio byte array.
3434
*
35-
* @param audioContent
35+
* @param audioContent based64 format audio.
3636
* @return audio byte array
3737
*/
3838
public static byte[] decode(String audioContent) {
@@ -43,8 +43,8 @@ public static byte[] decode(String audioContent) {
4343
*
4444
* update the global location to save temporary audio files.
4545
*
46-
* @param fileTempAudio
47-
* @return
46+
* @param fileTempAudio file path and name.
47+
* @return status true or false.
4848
*/
4949
public static boolean updateGlobalTempLocation(String fileTempAudio) {
5050
boolean res = false;
@@ -64,8 +64,8 @@ public static boolean updateGlobalTempLocation(String fileTempAudio) {
6464
*
6565
* This function created for testing purposes, it is recommended to use third party libraries for audio processing.
6666
*
67-
* @param decodedAudio
68-
* @return save status
67+
* @param decodedAudio audio byte format.
68+
* @return saving status
6969
*/
7070
public static boolean saveTempAudio(byte[] decodedAudio) {
7171
boolean res = true;
@@ -80,7 +80,6 @@ public static boolean saveTempAudio(byte[] decodedAudio) {
8080

8181
/**
8282
* clean the temporary audio files.
83-
*
8483
*/
8584
public static void deleteTempAudio() {
8685

0 commit comments

Comments
 (0)