diff mbox

[API-NEXT] linux-generic: time: add additional doxygen doc for time type

Message ID 20170602212449.6378-1-bill.fischofer@linaro.org
State Accepted
Commit e24f6b3d0c130af3838ba49661d4bc9cb83e940f
Headers show

Commit Message

Bill Fischofer June 2, 2017, 9:24 p.m. UTC
Latest doxygen requires all items to be documented so add doxygen for
enclosing union around variant time types.

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

---
 platform/linux-generic/include/odp/api/plat/time_types.h | 1 +
 1 file changed, 1 insertion(+)

-- 
2.11.0

Comments

Bill Fischofer June 2, 2017, 9:25 p.m. UTC | #1
Discovered this omission in testing v1.15.0.0 release candidate. This
needs to be merged to API-NEXT and pulled to NEXT for inclusion in the
v1.15.0.0 release.

On Fri, Jun 2, 2017 at 4:24 PM, Bill Fischofer
<bill.fischofer@linaro.org> wrote:
> Latest doxygen requires all items to be documented so add doxygen for

> enclosing union around variant time types.

>

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> ---

>  platform/linux-generic/include/odp/api/plat/time_types.h | 1 +

>  1 file changed, 1 insertion(+)

>

> diff --git a/platform/linux-generic/include/odp/api/plat/time_types.h b/platform/linux-generic/include/odp/api/plat/time_types.h

> index 71e354e6..e7111c8c 100644

> --- a/platform/linux-generic/include/odp/api/plat/time_types.h

> +++ b/platform/linux-generic/include/odp/api/plat/time_types.h

> @@ -26,6 +26,7 @@ extern "C" {

>   * implementations.

>   */

>  typedef struct odp_time_t {

> +       /** @internal Variant mappings for time type */

>         union {

>                 /** @internal Used with generic 64 bit operations */

>                 uint64_t u64;

> --

> 2.11.0

>
Dmitry Eremin-Solenikov June 2, 2017, 9:26 p.m. UTC | #2
On 03.06.2017 00:24, Bill Fischofer wrote:
> Latest doxygen requires all items to be documented so add doxygen for

> enclosing union around variant time types.

> 

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>


Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>


-- 
With best wishes
Dmitry
Maxim Uvarov June 13, 2017, 2:35 p.m. UTC | #3
Merged.

On 06/03/17 00:26, Dmitry Eremin-Solenikov wrote:
> On 03.06.2017 00:24, Bill Fischofer wrote:

>> Latest doxygen requires all items to be documented so add doxygen for

>> enclosing union around variant time types.

>>

>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> 

> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>

>
diff mbox

Patch

diff --git a/platform/linux-generic/include/odp/api/plat/time_types.h b/platform/linux-generic/include/odp/api/plat/time_types.h
index 71e354e6..e7111c8c 100644
--- a/platform/linux-generic/include/odp/api/plat/time_types.h
+++ b/platform/linux-generic/include/odp/api/plat/time_types.h
@@ -26,6 +26,7 @@  extern "C" {
  * implementations.
  */
 typedef struct odp_time_t {
+	/** @internal Variant mappings for time type */
 	union {
 		/** @internal Used with generic 64 bit operations */
 		uint64_t u64;