From d7bd5db9b6b8c5e7da232c8f288589e2b65b958e Mon Sep 17 00:00:00 2001 From: Davide Faconti Date: Tue, 5 May 2026 13:05:23 +0200 Subject: [PATCH] docs(pj_scene_protocol): point at sibling ARCHITECTURE.md, not pj_media MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The schema-spec headers used to point at `pj_media/docs/datatypes_2D.md §8` for the canonical type catalog, dating from when this module lived inside PJ4's pj_media tree. After the relocation in #81, that PJ4 doc was rewritten to point AT pj_scene_protocol/docs/ARCHITECTURE.md — making the header cross-reference circular. Both header comments now point at the sibling docs/ARCHITECTURE.md. Drops the residual `pj_media`-specific phrasing from scene_decoder.h's class comment. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../include/pj_scene_protocol/image_annotation.h | 4 ++-- .../include/pj_scene_protocol/scene_decoder.h | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pj_scene_protocol/include/pj_scene_protocol/image_annotation.h b/pj_scene_protocol/include/pj_scene_protocol/image_annotation.h index 991a768..39d1da1 100644 --- a/pj_scene_protocol/include/pj_scene_protocol/image_annotation.h +++ b/pj_scene_protocol/include/pj_scene_protocol/image_annotation.h @@ -8,8 +8,8 @@ namespace PJ { -/// Vertex topology for vector annotations. Mirrors the canonical primitive set -/// from `pj_media/docs/datatypes_2D.md` §8. +/// Vertex topology for vector annotations. See `docs/ARCHITECTURE.md` +/// for the full type catalog and wire format spec. enum class AnnotationTopology : uint8_t { kPoints, ///< Each point is independent. kLineList, ///< Consecutive pairs form segments (0-1, 2-3, ...). diff --git a/pj_scene_protocol/include/pj_scene_protocol/scene_decoder.h b/pj_scene_protocol/include/pj_scene_protocol/scene_decoder.h index 02f3a91..f4391b7 100644 --- a/pj_scene_protocol/include/pj_scene_protocol/scene_decoder.h +++ b/pj_scene_protocol/include/pj_scene_protocol/scene_decoder.h @@ -10,14 +10,14 @@ namespace PJ { -/// Decodes canonical wire-format bytes (foxglove.ImageAnnotations Protobuf — -/// the schema documented in `pj_media/docs/datatypes_2D.md §8` and serialized -/// by `pj_scene_protocol::serializeImageAnnotation`) into a `SceneFrame` of -/// vector primitives. Stateless — one instance per scene/annotation layer. +/// Decodes canonical wire-format bytes (foxglove.ImageAnnotations Protobuf, +/// serialized by `pj_scene_protocol::serializeImageAnnotation`) into a +/// `SceneFrame` of vector primitives. Stateless — one instance per +/// scene/annotation layer. See `docs/ARCHITECTURE.md` for the wire format spec. /// /// There is exactly ONE decoder kind. Per-source-format conversion (e.g. CDR /// `vision_msgs/msg/Detection2DArray` → canonical bytes) lives loader-side and -/// is invisible to pj_media. +/// is invisible to consumers of this module. class ISceneDecoder { public: virtual ~ISceneDecoder() = default;