Cleanup and add docs#86
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #86 +/- ##
===========================================
- Coverage 76.98% 76.97% -0.02%
===========================================
Files 94 94
Lines 4750 4752 +2
Branches 444 444
===========================================
+ Hits 3657 3658 +1
- Misses 1093 1094 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| /// @param s Input stream containing a serialised ExtractionResult. | ||
| explicit ExtractionResult(eckit::Stream& s); | ||
|
|
||
| /// @brief Copy construction is disabled (move-only type). |
There was a problem hiding this comment.
This kind of doc is not useful.
There was a problem hiding this comment.
Removed the redundant @param docs — the class-level doc already covers what values and mask represent. (9141442)
| /// @param filename File path. | ||
| /// @param scheme URI scheme (for example "file"). | ||
| /// @param offset Byte offset of the target GRIB message. | ||
| /// @param host Optional host for remote access. |
There was a problem hiding this comment.
The docs say host port are optional, but the implementation does not.
There was a problem hiding this comment.
Removed "Optional" from both @param host and @param port — they are required parameters. (9141442)
| #include <algorithm> | ||
| #include <cassert> | ||
|
|
||
| #include "Range.h" |
There was a problem hiding this comment.
May as well update these to use full paths while we're at it
There was a problem hiding this comment.
The include was already updated to use the full path "gribjump/compression/Range.h" after the merge with develop.
There was a problem hiding this comment.
Not actually a useful example without FDB archival.
There was a problem hiding this comment.
Removed simple_extract.cc and updated README.md accordingly. (9141442)
…, pragma once placement - Remove duplicate GribJumpBase.h include in GribJumpBase.cc - Reorder includes in Forwarder.cc, Range.cc, gribjump_c.cc, Request.cc (system headers first, then third-party, then project headers) - Move pragma once before includes in GribJumpFactory.h - Remove redundant GribJumpBase.h include from GribJump.h, add direct includes for types actually used (map, PathName, Metrics) - Fix GribJumpFactory.h to include Config.h directly instead of relying on transitive includes through GribJump.h
Move source files from flat layout into api/, core/, config/, plugins/ subdirectories and update all include paths across the codebase. Directory structure: - api/: Public API (GribJump, GribJumpBase, GribJumpFactory, gribjump_c, ExtractionData, ExtractionItem, ExtractionIterator, Types, GribJumpException) - core/: Internal engine (Engine, Task, Lister, Forwarder, LocalGribJump, URIHelper, GribJumpDataAccessor) - config/: Configuration (LibGribJump, Config, Metrics, Stats, LogRouter) - plugins/: FDB plugin Updated CMakeLists.txt source paths and all #include directives in src/, tests/, and tools/ to reflect new locations.
- Add full Doxygen blocks to 5 public API headers: GribJump.h, GribJumpBase.h, gribjump_c.h, ExtractionData.h, ExtractionItem.h - Create docs/Doxyfile for HTML API reference generation - Create docs/examples/simple_extract.cc minimal C++ extraction example - Create docs/examples/README.md with setup and run instructions
caraghbiner
force-pushed
the
feature/tidy-and-docs
branch
from
66d95cb to
f47d206
Compare
|
@copilot resolve the merge conflicts in this pull request |
Agent-Logs-Url: https://github.com/ecmwf/gribjump/sessions/d3354713-669c-4eb4-9be1-44a49717692d Co-authored-by: ChrisspyB <8879093+ChrisspyB@users.noreply.github.com>
Description
Some long awaited cleanup:
Contributor Declaration
By opening this pull request, I affirm the following: