Skip to content

Add Javadoc to all public methods in de.rub.nds.crawler package #27

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ic0ns
Copy link
Contributor

@ic0ns ic0ns commented Jun 19, 2025

Summary

  • Added comprehensive Javadoc documentation to all public methods in the de.rub.nds.crawler package
  • Documented all classes including configuration, core components, data models, providers, and utilities
  • Each commit focuses on a specific set of related classes for easier review

ic0ns added 6 commits June 19, 2025 10:17
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant