All public classes, methods, and parameters must have comprehensive JavaDoc documentation. This includes: 1. **Class-level JavaDoc**: Every public class and interface requires JavaDoc explaining its purpose and usage
All public classes, methods, and parameters must have comprehensive JavaDoc documentation. This includes:
@Deprecated
annotation without metadata and add corresponding @deprecated
JavaDoc tag with version and replacement informationExample for deprecated code:
/**
* @deprecated Since 4.2 and should not be used any longer.
* @see org.apache.kafka.streams.StreamsConfig
*/
@Deprecated
public class BrokerNotFoundException {
// implementation
}
Example for new parameters:
/**
* Creates a new RecordAccumulator instance.
* @param logContext the log context
* @param batchSize the batch size
* @param kafka19012Instrumentation instrumentation for KAFKA-19012 metrics
*/
public RecordAccumulator(LogContext logContext,
int batchSize,
Kafka19012Instrumentation kafka19012Instrumentation) {
// implementation
}
This ensures consistent documentation standards and helps maintain code readability and API usability for both internal developers and external users.
Enter the URL of a public GitHub repository