docs: Add Rustdoc to meta_plugin, filter_plugin, common, lib, and filter_service

Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-09-10 13:52:46 -03:00
parent 70070de9fa
commit 099698e388
2 changed files with 43 additions and 45 deletions

10
PLAN.md
View File

@@ -44,28 +44,28 @@ Private helpers (e.g., internal `fn` without `pub`) are not flagged, as they don
- `get_tags_for_items()` and `get_meta_for_items()` functions: Partial.
- Overall: Many CRUD functions lack full docs; the module-level doc is good but individual items are inconsistent.
3. **src/meta_plugin/read_rate.rs**
3. **src/meta_plugin/read_rate.rs** [DONE]
- `ReadRateMetaPlugin` struct: Missing doc comment.
- `new()` function: Partial (missing full param docs).
- Impl `MetaPlugin` methods (`is_finalized`, `set_finalized`, `finalize`, `update`, `meta_type`, `outputs`, etc.): No docs.
- Overall: Lacks docs for the public trait impl.
4. **src/filter_plugin/head.rs**
4. **src/filter_plugin/head.rs** [DONE]
- `HeadBytesFilter` and `HeadLinesFilter` structs: No docs.
- `new()` functions: Partial.
- Impl `FilterPlugin` methods (`filter`, `clone_box`, `options`): No docs.
- Overall: No rustdoc at all for public impl.
5. **src/common/binary_detection.rs**
5. **src/common/binary_detection.rs** [DONE]
- `check_binary_content_allowed()` function: Partial (missing examples).
- `is_content_binary()` function: Partial.
- Overall: Functions lack full error handling docs.
6. **src/lib.rs**
6. **src/lib.rs** [DONE]
- Module re-exports and `init_plugins()` function: No docs.
- Overall: Library-level docs are minimal.
7. **src/services/filter_service.rs**
7. **src/services/filter_service.rs** [DONE]
- `FilterService` struct: Partial doc.
- `new()`, `create_filter_chain()`, `filter_data()`, `process_with_filter()` methods: Partial or missing.
- `register_filter_plugin()` and `get_available_filter_plugins()` functions: Partial.