Skip to content

Commit

Permalink
Fix binning creator doc and enable it to show in doxygen by enabling …
Browse files Browse the repository at this point in the history
…openPMD macro
  • Loading branch information
ikbuibui committed Jan 31, 2025
1 parent 8ea3134 commit f750a5f
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 4 deletions.
79 changes: 79 additions & 0 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,82 @@ EXTENSION_MAPPING = .cu=C++ \
.param=C++ \
.unitless=C++ \
.loader=C++


#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------

# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.

ENABLE_PREPROCESSING = YES

# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

MACRO_EXPANSION = YES

# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

EXPAND_ONLY_PREDEF = NO

# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

SEARCH_INCLUDES = YES

# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.

INCLUDE_PATH =

# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

INCLUDE_FILE_PATTERNS =

# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = ENABLE_OPENPMD

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

EXPAND_AS_DEFINED =

# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

SKIP_FUNCTION_MACROS = YES
6 changes: 2 additions & 4 deletions include/picongpu/plugins/binning/BinningCreator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
# include "picongpu/plugins/binning/Binner.hpp"
# include "picongpu/plugins/binning/BinningData.hpp"

# include <functional>
# include <memory>
# include <vector>

# include <openPMD/Series.hpp>

Expand Down Expand Up @@ -56,10 +58,6 @@ namespace picongpu
* @param axisTupleObject tuple holding the axes
* @param speciesTupleObject tuple holding the species to do the binning with
* @param depositionData functorDescription of the deposited quantity
* @param notifyPeriod The periodicity of the output
* @param dumpPeriod The number of notify steps to accumulate over. Dump at the end. Defaults to 1.
* @param timeAveraging Time average the accumulated data when doing the dump. Defaults to true.
* @param normalizeByBinVolume defaults to true
* @param writeOpenPMDFunctor Functor to write out user specified openPMD data
*/
template<typename TAxisTuple, typename TSpeciesTuple, typename TDepositionData>
Expand Down

0 comments on commit f750a5f

Please sign in to comment.