From 945d569fe65ca218dd376cc402f095f5a36575c8 Mon Sep 17 00:00:00 2001 From: Christian Heinrich Date: Fri, 12 Feb 2016 18:14:36 +0100 Subject: [PATCH 1/1] [XBT] Added some markup and "\see" to comment --- include/xbt/dynar.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index 7dfff27998..0a9e47f567 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -214,12 +214,14 @@ XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar); XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor); -/* do not use this structure internals directly, but use the public interface - * This was made public to allow: - * - the inlining of the foreach elements - * - sending such beasts over the network +/* + * \warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface: + * This was made public to allow: + * - the inlining of the foreach elements + * - sending such beasts over the network + * + * \see xbt_dynar_length() */ - typedef struct xbt_dynar_s { unsigned long size; unsigned long used; -- 2.20.1