Nikita Awasthi created NIFI-15666:
-------------------------------------
Summary: Complete NaiveSearchRingBuffer usage example in Javadoc
Key: NIFI-15666
URL: https://issues.apache.org/jira/browse/NIFI-15666
Project: Apache NiFi
Issue Type: Improvement
Components: Documentation & Website
Reporter: Nikita Awasthi
The NaiveSearchRingBuffer class contains an incomplete Javadoc example with a
TODO placeholder instead of providing a working code example. This makes it
difficult for developers to understand proper usage.
Current Javadoc example:
```java
final byte[] searchSequence; //TODO assignment
final CircularBuffer buffer = new CircularBuffer(searchSequence);
```
Issues with current example:
1. Contains TODO instead of actual implementation
2. Uses incorrect class name (CircularBuffer vs NaiveSearchRingBuffer)
3. Missing proper constructor call example
4. No context about realistic use cases
Proposed improvement: Replace with complete, working example showing newline
delimiter search (common use case).
This change will improve developer experience by providing copy-paste ready
example code.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
