Skip to content

Commit 25ace65

Browse files
authored
docs(javadoc): resolve missing Javadoc warnings (#169)
Add Javadoc for undocumented default constructors in CookieConfig, CredentialsConfig, and WebAuthenticationConfig, document PsExtractor .extractText, add missing @param sitemapBaseUrl to SitemapsHelper parse methods, and document the SizeLimitedInputStream constructor.
1 parent 5eac93e commit 25ace65

5 files changed

Lines changed: 34 additions & 0 deletions

File tree

fess-crawler/src/main/java/org/codelibs/fess/crawler/client/http/config/CookieConfig.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@
3737
*/
3838
public class CookieConfig {
3939

40+
/**
41+
* Creates a new CookieConfig instance.
42+
*/
43+
public CookieConfig() {
44+
// Default constructor
45+
}
46+
4047
private String name;
4148
private String value;
4249
private String domain;

fess-crawler/src/main/java/org/codelibs/fess/crawler/client/http/config/CredentialsConfig.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@
3737
*/
3838
public class CredentialsConfig {
3939

40+
/**
41+
* Creates a new CredentialsConfig instance.
42+
*/
43+
public CredentialsConfig() {
44+
// Default constructor
45+
}
46+
4047
/**
4148
* Type of credentials.
4249
*/

fess-crawler/src/main/java/org/codelibs/fess/crawler/client/http/config/WebAuthenticationConfig.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@
4848
*/
4949
public class WebAuthenticationConfig {
5050

51+
/**
52+
* Creates a new WebAuthenticationConfig instance.
53+
*/
54+
public WebAuthenticationConfig() {
55+
// Default constructor
56+
}
57+
5158
/**
5259
* Type of authentication scheme.
5360
*/

fess-crawler/src/main/java/org/codelibs/fess/crawler/extractor/impl/PsExtractor.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,11 @@ public void setEncoding(final String encoding) {
9999
this.encoding = encoding;
100100
}
101101

102+
/**
103+
* Extracts readable text from the given PostScript content.
104+
* @param psContent the PostScript content to extract text from
105+
* @return the extracted text
106+
*/
102107
protected String extractText(final String psContent) {
103108
final List<String> collectedTexts = new ArrayList<>();
104109
final List<String> stack = new ArrayList<>();

fess-crawler/src/main/java/org/codelibs/fess/crawler/helper/SitemapsHelper.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,7 @@ protected SitemapSet parse(final InputStream in, final boolean recursive, final
212212
/**
213213
* Parses a text-based sitemap from the given input stream.
214214
* @param in the input stream to parse
215+
* @param sitemapBaseUrl the base URL used to resolve relative sitemap URLs
215216
* @return the parsed sitemap set
216217
*/
217218
protected SitemapSet parseTextSitemaps(final InputStream in, final String sitemapBaseUrl) {
@@ -265,6 +266,7 @@ protected SitemapSet parseTextSitemaps(final InputStream in, final String sitema
265266
/**
266267
* Parses an XML sitemap from the given input stream.
267268
* @param in the input stream to parse
269+
* @param sitemapBaseUrl the base URL used to resolve relative sitemap URLs
268270
* @return the parsed sitemap set
269271
*/
270272
protected SitemapSet parseXmlSitemaps(final InputStream in, final String sitemapBaseUrl) {
@@ -699,6 +701,7 @@ public SitemapSet getSitemapSet() {
699701
/**
700702
* Parses an XML sitemap index from the given input stream.
701703
* @param in the input stream to parse
704+
* @param sitemapBaseUrl the base URL used to resolve relative sitemap URLs
702705
* @return the parsed sitemap set
703706
*/
704707
protected SitemapSet parseXmlSitemapsIndex(final InputStream in, final String sitemapBaseUrl) {
@@ -1161,6 +1164,11 @@ protected static class SizeLimitedInputStream extends FilterInputStream {
11611164

11621165
private long bytesRead;
11631166

1167+
/**
1168+
* Creates a new SizeLimitedInputStream wrapping the given input stream.
1169+
* @param in the input stream to wrap
1170+
* @param maxSize the maximum number of bytes allowed to be read
1171+
*/
11641172
protected SizeLimitedInputStream(final InputStream in, final long maxSize) {
11651173
super(in);
11661174
this.maxSize = maxSize;

0 commit comments

Comments
 (0)