documentation - Can doxygen be used to document makefile templates and include *.mk file interfaces? -
we have number of makefile templates, realize build actions setting few parameter makefile variables, , applying makefile template via inclusion
generic_param1-y := parama generic_param2-y := paramb include $(make_tools)/doaction.mk
and files doaction.mk
contain make templates generate standard rule definitions applied when including action make step.
now want document these interfaces *.mk
snippets using doxygen like
## @file ## @brief doaction.mk purposed ... ## ## more detailed descriptions rules applied ... ## @param generic_param1-y parameter1 description ... ## @param generic_param2-y parameter2 description ...
is there simple way achieve using valid doxygen syntax/configuration?
"is there simple way achieve using valid doxygen syntax/configuration?"
yes, can use doxygen's input_filter
, file_patterns
, filter_source_files
configuration settings as stolen blog post
put these settings in doxyfile
configuration
file_patterns = *.mk input_filter = "sed -e 's|##|//!|'" filter_source_files = yes
the input_filter
trick, sed
command used doxygen open pipe filtering input files along specified command.
note:
above mentioned command isn't embedded shell, chained command statements
"grep '##' | sed -e 's|##|//!|'"
won't work.
put comments proposed in sample ##
expand comments seen doxygen
## @file ## @brief doaction.mk purposed ... ## ## more detailed descriptions rules applied ... ## @param generic_param1-y parameter1 description ... ## @param generic_param2-y parameter2 description ...
additionally should put
## @cond ... ## @endcond
around makefile rules/templates code, avoid doxygen parsing these parts.
the above sample should render follows in generated documentation html
Comments
Post a Comment