Skip to content

Commit ef1d052

Browse files
committed
reword javadoc and documentation
1 parent 0e501fa commit ef1d052

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

PRIVACY_POLICY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For the purposes of this Privacy Policy:
2020
- __Affiliate__ means an entity that controls, is controlled by or is under common control with a party, where "control" means ownership of 50% or more of the shares, equity interest or other securities entitled to vote for election of directors or other managing authority.
2121
- __Application__ refers to Stickerify, the software program provided by the Company.
2222
- __Company__ (referred to as either "the Company", "We", "Us" or "Our" in this Agreement) refers to Stickerify.
23-
- __Country__ refers to: Italy
23+
- __Country__ refers to: Italy
2424
- __Device__ means any device that can access the Service such as a computer, a cellphone or a digital tablet.
2525
- __Personal Data__ is any information that relates to an identified or identifiable individual.
2626
- __Service__ refers to the Application.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ to convert.
2222

2323
Based on what you send, [Stickerify](https://t.me/StickerifyImageBot) will answer the following:
2424

25-
* the converted media, if you sent a supported file (images, gifs, videos, and existing Telegram stickers are supported)
25+
* the converted media, if you sent a supported file (images, GIFs, videos, and existing Telegram stickers are supported)
2626
that needed conversion
2727
* no file, if you sent a media already suiting Telegram's requirements
2828
* an error message, if you sent either an unsupported or a corrupted file
@@ -88,7 +88,7 @@ After you successfully set up the project, you will have to go through the follo
8888
docker pull rob93c/stickerify
8989
```
9090

91-
3. Now you just need to run the Docker image passing the token (`{{TOKEN}}`) retrieved
91+
3. Now you need to run the Docker image passing the token (`{{TOKEN}}`) retrieved
9292
from [BotFather](https://t.me/BotFather):
9393

9494
```shell
@@ -111,7 +111,7 @@ If you would like to improve [Stickerify](https://t.me/StickerifyImageBot) as pa
111111
the [contributing guidelines](CONTRIBUTING.md) and then consider opening a new issue _and/or_ pull request.
112112
113113
If your pull request represents a valid contribution to the project, it will be marked as `hacktoberfest-accepted`,
114-
therefore counting towards the 4 contributions goal.
114+
therefore counting towards the four-contribution goal.
115115
116116
## Useful information
117117

src/main/java/com/github/stickerifier/stickerify/logger/ExceptionHighlighter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import ch.qos.logback.core.pattern.Converter;
1313

1414
/**
15-
* Custom converter class to be used by Logback in order to highlight important substrings in exception logs.
15+
* Custom converter class to be used by Logback to highlight important substrings in exception logs.
1616
*
1717
* @see Converter
1818
*/

src/main/java/com/github/stickerifier/stickerify/logger/MessageHighlighter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
import ch.qos.logback.core.pattern.Converter;
1616

1717
/**
18-
* Custom converter class to be used by Logback in order to highlight important substrings.
18+
* Custom converter class to be used by Logback to highlight important substrings.
1919
*
2020
* @see Converter
2121
*/

src/main/java/com/github/stickerifier/stickerify/media/MediaHelper.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public static File convert(File inputFile) throws MediaException {
9292
}
9393

9494
/**
95-
* Analyses the file in order to detect its media type.
95+
* Analyzes the file to detect its media type.
9696
*
9797
* @param file the file sent to the bot
9898
* @return the MIME type of the passed-in file
@@ -113,7 +113,7 @@ private static String detectMimeType(File file) {
113113

114114
/**
115115
* Checks if the file is a {@code gzip} archive, then it reads its content and verifies if it's a valid JSON.
116-
* Once JSON information are retrieved, they are validated against Telegram's requirements.
116+
* Once JSON information is retrieved, they are validated against Telegram's requirements.
117117
*
118118
* @param file the file to check
119119
* @param mimeType the MIME type of the file
@@ -179,7 +179,7 @@ private static boolean isAnimationCompliant(AnimationDetails animation) {
179179
}
180180

181181
/**
182-
* Checks that passed-in file's size does not exceed specified threshold.
182+
* Checks that passed-in file's size does not exceed the specified threshold.
183183
*
184184
* @param file the file to check
185185
* @param threshold max allowed file size
@@ -268,7 +268,7 @@ private static boolean isSizeCompliant(int width, int height) {
268268
*
269269
* @param image the image to convert to WebP
270270
* @return converted image
271-
* @throws MediaException if an error occurs creating the temp file or
271+
* @throws MediaException if an error occurred creating the temp file, or
272272
* if the image size could not be reduced enough to meet Telegram's requirements
273273
*/
274274
private static File createWebpFile(ImmutableImage image) throws MediaException {
@@ -295,7 +295,7 @@ private static File createWebpFile(ImmutableImage image) throws MediaException {
295295
}
296296

297297
/**
298-
* Creates a new temp file with desired extension.
298+
* Creates a new temp file with the desired extension.
299299
*
300300
* @param fileExtension the extension of the new file
301301
* @return a new temp file

src/main/java/com/github/stickerifier/stickerify/process/ProcessHelper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ private static String readStream(InputStream stream) throws IOException {
6666
}
6767

6868
/**
69-
* Reads the content of the input stream of the process.
69+
* Reads the content of the input stream.
7070
* If the input stream is empty, the content of the error stream is returned.
7171
*
7272
* @param process the process

0 commit comments

Comments
 (0)