On 08/15/2014 09:15 PM, Aws Ismail wrote: > > > On 08/15/2014 12:17 PM, Taras Kondratiuk wrote: >> On 08/14/2014 07:44 PM, Aws Ismail wrote: >>> According to the CI job for ODP API doxygen generation [1], there are 28 >>> total >>> warnings that needed to be fixed. This patch resolved these warnings by >>> adding the >>> proper doxygen tags that were missing. >>> >>> [1]: https://ci.linaro.org/view/lng-ci/job/odp-api-doxygen-generation/ >>> >>> Signed-off-by: Aws Ismail <[email protected]> >>> --- >>> example/l2fwd/odp_l2fwd.c | 35 >>> ++++++++++++++++++++++++++++++ >>> example/odp_example/odp_example.c | 19 +++++++++++++++- >>> example/packet/odp_pktio.c | 26 ++++++++++++++++++++++ >>> example/packet_netmap/odp_pktio_netmap.c | 30 +++++++++++++++++++++++-- >>> 4 files changed, 107 insertions(+), 3 deletions(-) >>> >>> diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c >>> index f89ea7a..d74449a 100644 >>> --- a/example/l2fwd/odp_l2fwd.c >>> +++ b/example/l2fwd/odp_l2fwd.c >>> @@ -21,14 +21,40 @@ >>> #include <helper/odp_eth.h> >>> #include <helper/odp_ip.h> >>> >>> +/** @def MAX_WORKERS >>> + * @brief Maximum number of worker threads >>> + */ >> Why are you defining a full form with @def, @fn, etc? >> Won't the following give the same result? >> >> /** >> * Maximum number of worker threads >> */ >> > It would. It is just a matter of choice. I see that /** foo */ would be > more suited for commenting source code. > I could go back and change that if you think that's the proper approach.
In case of full form it is very easy to change function name and forget to update comment. IMO it is good to avoid data duplication and its synchronization in future. This is not a strong objection. If our documentation maintainers are fine, then let it be. -- Taras Kondratiuk _______________________________________________ lng-odp mailing list [email protected] http://lists.linaro.org/mailman/listinfo/lng-odp
