Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/graphics/mapper/2.0/IMapper.hal b/graphics/mapper/2.0/IMapper.hal
index 21a6dfa..573dcd0 100644
--- a/graphics/mapper/2.0/IMapper.hal
+++ b/graphics/mapper/2.0/IMapper.hal
@@ -27,7 +27,7 @@
int32_t height;
};
- /*
+ /**
* Adds a reference to the given buffer handle.
*
* A buffer handle received from a remote process or exported by
@@ -49,7 +49,7 @@
@callflow(next="*")
retain(handle bufferHandle) generates (Error error);
- /*
+ /**
* Removes a reference from the given buffer buffer.
*
* If no references remain, the buffer handle must be freed with
@@ -65,7 +65,7 @@
@exit
release(handle bufferHandle) generates (Error error);
- /*
+ /**
* Gets the width and height of the buffer in pixels.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -82,7 +82,7 @@
uint32_t width,
uint32_t height);
- /*
+ /**
* Gets the format of the buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -97,7 +97,7 @@
generates (Error error,
PixelFormat format);
- /*
+ /**
* Gets the number of layers of the buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -112,7 +112,7 @@
generates (Error error,
uint32_t layerCount);
- /*
+ /**
* Gets the producer usage flags which were used to allocate this buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -128,7 +128,7 @@
generates (Error error,
uint64_t usageMask);
- /*
+ /**
* Gets the consumer usage flags which were used to allocate this buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -144,7 +144,7 @@
generates (Error error,
uint64_t usageMask);
- /*
+ /**
* Gets a value that uniquely identifies the backing store of the given
* buffer.
*
@@ -165,7 +165,7 @@
generates (Error error,
BackingStore store);
- /*
+ /**
* Gets the stride of the buffer in pixels.
*
* The stride is the offset in pixel-sized elements between the same
@@ -185,7 +185,7 @@
generates (Error error,
uint32_t stride);
- /*
+ /**
* Locks the given buffer for the specified CPU usage.
*
* Exactly one of producerUsageMask and consumerUsageMask must be 0. The
@@ -247,7 +247,7 @@
generates (Error error,
pointer data);
- /*
+ /**
* This is largely the same as lock(), except that instead of returning a
* pointer directly to the buffer data, it returns an FlexLayout struct
* describing how to access the data planes.
@@ -296,7 +296,7 @@
generates (Error error,
FlexLayout layout);
- /*
+ /**
* This function indicates to the device that the client will be done with
* the buffer when releaseFence signals.
*
diff --git a/graphics/mapper/2.0/types.hal b/graphics/mapper/2.0/types.hal
index aa33141..2946e85 100644
--- a/graphics/mapper/2.0/types.hal
+++ b/graphics/mapper/2.0/types.hal
@@ -16,7 +16,7 @@
package android.hardware.graphics.mapper@2.0;
-/*
+/**
* Structures for describing flexible YUVA/RGBA formats for consumption by
* applications. Such flexible formats contain a plane for each component (e.g.
* red, green, blue), where each plane is laid out in a grid-like pattern
@@ -49,19 +49,19 @@
*/
enum FlexComponent : int32_t {
- Y = 1 << 0, /* luma */
- CB = 1 << 1, /* chroma blue */
- CR = 1 << 2, /* chroma red */
+ Y = 1 << 0, /** luma */
+ CB = 1 << 1, /** chroma blue */
+ CR = 1 << 2, /** chroma red */
- R = 1 << 10, /* red */
- G = 1 << 11, /* green */
- B = 1 << 12, /* blue */
+ R = 1 << 10, /** red */
+ G = 1 << 11, /** green */
+ B = 1 << 12, /** blue */
- A = 1 << 30, /* alpha */
+ A = 1 << 30, /** alpha */
};
enum FlexFormat : int32_t {
- /* not a flexible format */
+ /** not a flexible format */
INVALID = 0x0,
Y = FlexComponent:Y,
@@ -73,38 +73,38 @@
};
struct FlexPlane {
- /* Pointer to the first byte of the top-left pixel of the plane. */
+ /** Pointer to the first byte of the top-left pixel of the plane. */
pointer topLeft;
FlexComponent component;
- /*
+ /**
* Bits allocated for the component in each pixel. Must be a positive
* multiple of 8.
*/
int32_t bitsPerComponent;
- /*
+ /**
* Number of the most significant bits used in the format for this
* component. Must be between 1 and bitsPerComponent, inclusive.
*/
int32_t bitsUsed;
- /* Horizontal increment. */
+ /** Horizontal increment. */
int32_t hIncrement;
- /* Vertical increment. */
+ /** Vertical increment. */
int32_t vIncrement;
- /* Horizontal subsampling. Must be a positive power of 2. */
+ /** Horizontal subsampling. Must be a positive power of 2. */
int32_t hSubsampling;
- /* Vertical subsampling. Must be a positive power of 2. */
+ /** Vertical subsampling. Must be a positive power of 2. */
int32_t vSubsampling;
};
struct FlexLayout {
- /* The kind of flexible format. */
+ /** The kind of flexible format. */
FlexFormat format;
- /*
+ /**
* A plane for each component; ordered in increasing component value
* order. E.g. FlexFormat::RGBA maps 0 -> R, 1 -> G, etc. Can have size 0
* for FlexFormat::INVALID.
@@ -112,5 +112,5 @@
vec<FlexPlane> planes;
};
-/* Backing store ID of a buffer. See IMapper::getBackingStore. */
+/** Backing store ID of a buffer. See IMapper::getBackingStore. */
typedef uint64_t BackingStore;