Doxygen can't parse C function pointer signature -
doxygen (1.8.6) won't parse this, me:
/** @fn dynarray* dynmap(dynarray* array, void*(*callback)(void**, size_t, dynarray*)) @brief foo @param array bar @param callback baz blah blah blah */ extern dynarray* dynmap(dynarray*, void*(*)(void**, size_t, dynarray*)); am doing wrong, or bug? notice if remove argument names documentation, compile, albeit incorrectly (it mangles parameters). however, does work if match documentation signature exactly:
/** @fn dynarray* dynmap(dynarray* array, void*(*callback)(void**, size_t, dynarray*)) @brief foo @param array bar @param callback baz blah blah blah */ extern dynarray* dynmap(dynarray* array, void*(*callback)(void**, size_t, dynarray*)); however, array , callback in type definitions function, isn't particularly satisfying...
why use @fn while symbol want document right after comment block? not needed @ all.
if somehow cannot suppress urge use @fn should indeed match arguments declaration (or move comment block function definition).
see http://www.doxygen.org/manual/docblocks.html#structuralcommands more info
when working function pointers practice typedef them.
Comments
Post a Comment