[hipl-commit] [tiny] Rev 3696: Added further usage information to doxygen for lmod_packet_type_exists.
- From: Tim Just <tim.just@xxxxxxxxxxxxxx>
- To: hipl-commit@xxxxxxxxxxxxx
- Date: Thu, 18 Mar 2010 19:02:41 +0200
Committer: Tim Just <tim.just@xxxxxxxxxxxxxx>
Date: 18/03/2010 at 19:02:41
Revision: 3696
Revision-id: tim.just@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: tiny
Log:
Added further usage information to doxygen for lmod_packet_type_exists.
Modified:
M lib/modularization/lmod.c
=== modified file 'lib/modularization/lmod.c'
--- lib/modularization/lmod.c 2010-03-18 15:44:13 +0000
+++ lib/modularization/lmod.c 2010-03-18 17:02:19 +0000
@@ -473,6 +473,10 @@
*
* Check whether a certain packet type was already registered.
*
+ * @note The return value is not 0 (FALSE), if the packet type not exists.
+ * Therefore you have to check, if the return value is equal to -1, if
you
+ * want to check whether a packet type exists or not.
+ *
* @param packet_type The packet type number to search for.
*
* @return The index of the packet type, if existing or
Other related posts:
- » [hipl-commit] [tiny] Rev 3696: Added further usage information to doxygen for lmod_packet_type_exists. - Tim Just
