Macro-izing function declarations for standard math operations (Mul, MulC_I, etc) broke docstring generation
Issue #44
new
In FOpers.h, IOpers.h, etc. the standard math operations have been macroized so that the declarations look like:
/** @brief a_o = a_i * c */ FIELD_BINARY_ARRAY_OPC_FLOAT_DEC(Mul)
where FIELD_BINARY_ARRAY_OPC_FLOAT_DEC
is a macro. Unfortunately doxygen doesn't seem to expand macros, so the documentation doesn't get associated with the expanded function declaration (MulC).
Comments (2)
-
-
reporter I looked at this, but turning on MACRO_EXPANSION in the doxygen configuration doesn't do anything for me (the one used is at PyCA/Docs/Doxyfile). You can see from the solution posted by the OP, he had to make a separate .dox file to trick doxygen into generating the documentation. I discussed it with @jhinkle , I think for now the best solution is to un-macroize the declarations of functions in the public interface headers.
- Log in to comment
This might be help:
http://stackoverflow.com/questions/10550057/document-functions-defined-through-a-macro-in-doxygen