Skip to content

Commit 3c172a5

Browse files
jleibsjleibs
committed
Doc lints
1 parent e51c857 commit 3c172a5

6 files changed

Lines changed: 30 additions & 14 deletions

File tree

‎rerun_cpp/src/rerun/archetypes/depth_image.hpp‎

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rerun_cpp/src/rerun/archetypes/depth_image_ext.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ namespace rerun::archetypes {
1616
/// @param pixels The raw image data.
1717
/// ⚠️ Does not take ownership of the data, the caller must ensure the data outlives the image.
1818
/// The number of elements is assumed to be `W * H`.
19+
/// @param resolution The resolution of the image as {width, height}.
1920
template <typename TElement>
2021
DepthImage(const TElement* pixels, WidthHeight resolution)
2122
: DepthImage{reinterpret_cast<const uint8_t*>(pixels), resolution, get_datatype(pixels)} {}
@@ -26,6 +27,7 @@ namespace rerun::archetypes {
2627
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
2728
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
2829
/// The length of the data should be `W * H`.
30+
/// @param resolution The resolution of the image as {width, height}.
2931
template <typename TElement>
3032
DepthImage(Collection<TElement> pixels, WidthHeight resolution)
3133
: DepthImage{pixels.to_uint8(), resolution, get_datatype(pixels.data())} {}
@@ -35,6 +37,7 @@ namespace rerun::archetypes {
3537
/// @param data_ The raw image data.
3638
/// ⚠️ Does not take ownership of the data, the caller must ensure the data outlives the image.
3739
/// The byte size of the data is assumed to be `W * H * datatype.size`
40+
/// @param resolution The resolution of the image as {width, height}.
3841
/// @param datatype How the data should be interpreted.
3942
DepthImage(
4043
const void* data_, WidthHeight resolution,
@@ -49,6 +52,7 @@ namespace rerun::archetypes {
4952
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
5053
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
5154
/// The length of the data should be `W * H`.
55+
/// @param resolution The resolution of the image as {width, height}.
5256
/// @param datatype How the data should be interpreted.
5357
DepthImage(
5458
Collection<uint8_t> data_, WidthHeight resolution,

‎rerun_cpp/src/rerun/archetypes/image.hpp‎

Lines changed: 7 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rerun_cpp/src/rerun/archetypes/image_ext.cpp‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ namespace rerun::archetypes {
2929
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
3030
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
3131
/// The length of the data should be `W * H * pixel_format.bytes_per_pixel`.
32+
/// @param resolution The resolution of the image as {width, height}.
3233
/// @param pixel_format How the data should be interpreted.
3334
Image(
3435
Collection<uint8_t> bytes, WidthHeight resolution,
@@ -42,6 +43,7 @@ namespace rerun::archetypes {
4243
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
4344
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
4445
/// The length of the data should be `W * H * datatype.bytes * color_model.num_channels`.
46+
/// @param resolution The resolution of the image as {width, height}.
4547
/// @param color_model The color model of the pixel data.
4648
/// @param datatype Datatype of the individual channels of the color model.
4749
Image(
@@ -57,6 +59,7 @@ namespace rerun::archetypes {
5759
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
5860
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
5961
/// The length of the data should be `W * H * color_model.num_channels`.
62+
/// @param resolution The resolution of the image as {width, height}.
6063
/// @param color_model The color model of the pixel data.
6164
/// Each element in elements is interpreted as a single channel of the color model.
6265
template <typename T>
@@ -72,6 +75,7 @@ namespace rerun::archetypes {
7275
/// @param elements The raw image data.
7376
/// ⚠️ Does not take ownership of the data, the caller must ensure the data outlives the image.
7477
/// The number of elements is assumed to be `W * H * color_model.num_channels`.
78+
/// @param resolution The resolution of the image as {width, height}.
7579
/// @param color_model The color model of the pixel data.
7680
/// Each element in elements is interpreted as a single channel of the color model.
7781
template <typename T>
@@ -92,7 +96,7 @@ namespace rerun::archetypes {
9296
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
9397
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
9498
/// The length of the data should be `W * H`.
95-
/// @param resolution The resolution of the image.
99+
/// @param resolution The resolution of the image as {width, height}.
96100
static Image from_greyscale8(Collection<uint8_t> bytes, WidthHeight resolution) {
97101
return Image(bytes, resolution, datatypes::ColorModel::L, datatypes::ChannelDatatype::U8);
98102
}
@@ -103,7 +107,7 @@ namespace rerun::archetypes {
103107
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
104108
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
105109
/// The length of the data should be `W * H * 3`.
106-
/// @param resolution The resolution of the image.
110+
/// @param resolution The resolution of the image as {width, height}.
107111
static Image from_rgb24(Collection<uint8_t> bytes, WidthHeight resolution) {
108112
return Image(
109113
bytes,
@@ -119,7 +123,7 @@ namespace rerun::archetypes {
119123
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
120124
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
121125
/// The length of the data should be `W * H * 4`.
122-
/// @param resolution The resolution of the image.
126+
/// @param resolution The resolution of the image as {width, height}.
123127
static Image from_rgba32(Collection<uint8_t> bytes, WidthHeight resolution) {
124128
return Image(
125129
bytes,

‎rerun_cpp/src/rerun/archetypes/segmentation_image.hpp‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rerun_cpp/src/rerun/archetypes/segmentation_image_ext.cpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace rerun::archetypes {
1414
/// @param pixels The raw image data.
1515
/// ⚠️ Does not take ownership of the data, the caller must ensure the data outlives the image.
1616
/// The number of elements is assumed to be `W * H`.
17-
/// @param resolution The resolution of the image.
17+
/// @param resolution The resolution of the image as {width, height}.
1818
template <typename TElement>
1919
SegmentationImage(const TElement* pixels, WidthHeight resolution)
2020
: SegmentationImage{
@@ -27,7 +27,7 @@ namespace rerun::archetypes {
2727
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
2828
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
2929
/// The length of the data should be `W * H`.
30-
/// @param resolution The resolution of the image.
30+
/// @param resolution The resolution of the image as {width, height}.
3131
template <typename TElement>
3232
SegmentationImage(Collection<TElement> pixels, WidthHeight resolution)
3333
: SegmentationImage{pixels.to_uint8(), resolution, get_datatype(pixels.data())} {}
@@ -37,7 +37,7 @@ namespace rerun::archetypes {
3737
/// @param data_ The raw image data.
3838
/// ⚠️ Does not take ownership of the data, the caller must ensure the data outlives the image.
3939
/// The byte size of the data is assumed to be `W * H * datatype.size`
40-
/// @param resolution The resolution of the image.
40+
/// @param resolution The resolution of the image as {width, height}.
4141
/// @param datatype How the data should be interpreted.
4242
SegmentationImage(
4343
const void* data_, WidthHeight resolution,
@@ -52,7 +52,7 @@ namespace rerun::archetypes {
5252
/// If the data does not outlive the image, use `std::move` or create the `rerun::Collection`
5353
/// explicitly ahead of time with `rerun::Collection::take_ownership`.
5454
/// The length of the data should be `W * H`.
55-
/// @param resolution The resolution of the image.
55+
/// @param resolution The resolution of the image as {width, height}.
5656
/// @param datatype How the data should be interpreted.
5757
SegmentationImage(
5858
Collection<uint8_t> data_, WidthHeight resolution,

0 commit comments

Comments
 (0)