Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc Update: fix a few missing params and exclude a few packages #1463

Merged
merged 1 commit into from
Jul 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -686,7 +686,8 @@
</execution>
</executions>
<configuration>
<excludePackageNames>com.pinterest.secor.*</excludePackageNames>
<source>8</source>
<excludePackageNames>com.pinterest.secor.timestamp:com.pinterest.secor.reader:com.pinterest.secor.common:com.pinterest.secor.thrift</excludePackageNames>
</configuration>
</plugin>
<plugin>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
public interface MetricCollector {
/**
* Initialize the collector with SecorConfig
* @param config
* @param config configuration
*/
void initialize(SecorConfig config);

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/pinterest/secor/uploader/Uploader.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ public class Uploader {
* @param offsetTracker Tracker of the current offset of topics partitions
* @param fileRegistry Registry of log files on a per-topic and per-partition basis
* @param uploadManager Manager of the physical upload of log files to the remote repository
* @param messageReader messageReader
* @param metricCollector component that ingest metrics into monitoring system
* @param deterministicUploadPolicyTracker deterministicUploadPolicyTracker
*/
public void init(SecorConfig config, OffsetTracker offsetTracker, FileRegistry fileRegistry,
UploadManager uploadManager, MessageReader messageReader, MetricCollector metricCollector,
Expand Down Expand Up @@ -354,6 +356,7 @@ private boolean activeFileCountExceeded(int fileCount) {
* This method could be subclassed to provide an alternate policy. The custom uploader
* class name would need to be specified in the secor.upload.class.
*
* @param forceUpload forceUpload
* @throws Exception if any error occurs while appying the policy
*/
public void applyPolicy(boolean forceUpload) throws Exception {
Expand Down