I experimented with defgroup and ingroup.
Using ingroup means you have to tag each thing individually, trying to
combine it with "@{" was not successful so I think addtogroup is best, it
will concatenate large blocks of API.
In future we can go mark each thing with @ingroup <block name> if we need
that atomicity
defgroup can replace the major section addtogroup without a problem.
So having one defgroup with other regions marked with addtogroup appears
the way forward to me.
Mike
On 4 September 2014 11:07, Mike Holmes <[email protected]> wrote:
>
>
>
> On 4 September 2014 06:10, Stuart Haslam <[email protected]> wrote:
>
>> On Wed, Sep 03, 2014 at 03:18:11AM +0100, Mike Holmes wrote:
>> > Signed-off-by: Mike Holmes <[email protected]>
>> > ---
>> >
>> > This creates a new section in the documentaion to group everything
>> > related to buffers. It appears to make things much more acessable
>> > although it needs to have some real description added to the section.
>> >
>>
>> Looks better to me. It also allows more freedom within the implementation
>> to place things in different header files and still have the documentation
>> look the same.
>>
>> Small nit, I think it would be better to use defgroup and ingroup, rather
>> than addtogroup, to avoid any confusion about where the documentation for
>> that group should go (what happens if you document multiple addtogroups?).
>>
>
>
> We can make it explicit, I was thinking that it was easier to manage with
> the looser association.
> multiple add groups just concatenate without a warning.
>
>
>
>
>> --
>> Stuart.
>>
>> > platform/linux-generic/include/api/odp_buffer.h | 6 +++++-
>> > platform/linux-generic/include/api/odp_buffer_pool.h | 6 ++++++
>> > 2 files changed, 11 insertions(+), 1 deletion(-)
>> >
>> > diff --git a/platform/linux-generic/include/api/odp_buffer.h
>> b/platform/linux-generic/include/api/odp_buffer.h
>> > index d8577fd..4f348e4 100644
>> > --- a/platform/linux-generic/include/api/odp_buffer.h
>> > +++ b/platform/linux-generic/include/api/odp_buffer.h
>> > @@ -21,7 +21,10 @@ extern "C" {
>> >
>> > #include <odp_std_types.h>
>> >
>> > -
>> > +/**
>> > + * @addtogroup buffer
>> > + * @{
>> > + */
>> >
>> > /**
>> > * ODP buffer
>> > @@ -83,6 +86,7 @@ int odp_buffer_is_valid(odp_buffer_t buf);
>> > */
>> > void odp_buffer_print(odp_buffer_t buf);
>> >
>> > +/** @} */
>> >
>> > #ifdef __cplusplus
>> > }
>> > diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h
>> b/platform/linux-generic/include/api/odp_buffer_pool.h
>> > index fe88898..dd0ac43 100644
>> > --- a/platform/linux-generic/include/api/odp_buffer_pool.h
>> > +++ b/platform/linux-generic/include/api/odp_buffer_pool.h
>> > @@ -23,6 +23,11 @@ extern "C" {
>> > #include <odp_std_types.h>
>> > #include <odp_buffer.h>
>> >
>> > +/**
>> > + * @addtogroup buffer ODP Buffers and buffer Pools
>> > + * @{
>> > + */
>> > +
>> > /** Maximum queue name lenght in chars */
>> > #define ODP_BUFFER_POOL_NAME_LEN 32
>> >
>> > @@ -99,6 +104,7 @@ void odp_buffer_free(odp_buffer_t buf);
>> > */
>> > odp_buffer_pool_t odp_buffer_pool(odp_buffer_t buf);
>> >
>> > +/** @} */
>> >
>> > #ifdef __cplusplus
>> > }
>> > --
>> > 1.9.1
>> >
>>
>>
>>
>
>
> --
> *Mike Holmes*
> Linaro Technical Manager / Lead
> LNG - ODP
>
--
*Mike Holmes*
Linaro Technical Manager / Lead
LNG - ODP
_______________________________________________
lng-odp mailing list
[email protected]
http://lists.linaro.org/mailman/listinfo/lng-odp
