Add Javadoc to all public methods in de.rub.nds.crawler package #27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for both main methods explaining their purpose and parameters.
Document all public methods including: - Abstract class documentation - Constructor and validation methods - All getter and setter methods with property descriptions - Target provider and scan configuration methods - Inner validator classes (PositiveInteger and CronSyntax)
Document worker configuration class with all public methods including constructor, getters and setters for worker-specific properties.
Document core components: - BulkScanWorker: handle(), scan(), init(), cleanup() - BulkScanWorkerManager: singleton management and worker lifecycle - Controller: initialization, scheduling, and shutdown - Worker: job consumption startup
Document: - ProgressMonitor: bulk scan progress tracking and completion detection - SchedulerListenerShutdown: all 20 SchedulerListener interface methods - PublishBulkScanJob: job execution and target submission logic
Document: - Data classes: ScanConfig, BulkScanInfo, BulkScanJobCounters - Interface classes: consumer and provider interfaces - Target list providers: all implementations - Utility classes: CanceallableThreadPoolExecutor and CancellableFuture
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary