diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 3024fcd337..4744982cff 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -2452,3 +2452,12 @@ GENERATE_LEGEND = YES # This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = YES diff --git a/include/miopen/miopen.h b/include/miopen/miopen.h index 614377cbd3..45b0fb43be 100644 --- a/include/miopen/miopen.h +++ b/include/miopen/miopen.h @@ -2994,9 +2994,10 @@ MIOPEN_EXPORT miopenStatus_t miopenFusionPlanGetOp(miopenFusionPlanDescriptor_t miopenFusionOpDescriptor_t* op); /*! @brief Query the workspace size required for the fusion plan - * + * @param handle MIOpen handle (input) * @param fusePlanDesc A fusion plan descriptor (input) * @param workSpaceSize Pointer to memory to return size in bytes (output) + * @param algo Algorithm selected (inputs) * @return miopenStatus_t */ MIOPEN_EXPORT miopenStatus_t @@ -3327,12 +3328,29 @@ miopenExecuteFusionPlan(const miopenHandle_t handle, void* output, miopenOperatorArgs_t args); -/*! @brief Prepares and executes the Convlution+Bias+Activation Fusion - * - * - * @param handle MIOpen handle (input) - * @return miopenStatus_t +/*! @brief Prepares and executes the Convlution+Bias+Activation Fusion. + * + * + * @param handle MIOpen handle (input) + * @param alpha1 floating point scaling factor, allocated on the host (input) + * @param xDesc Tensor descriptor for input data tensor x (input) + * @param x Data tensor x (input) + * @param wDesc Tensor descriptor for weight tensor w (input) + * @param w Weights tensor w (input) + * @param convDesc Convolution layer descriptor (input) + * @param algo Algorithm selected (inputs) + * @param workspace Pointer to workspace required (input) + * @param workspaceSizeInBytes Size of the memory in bytes pointed to by workSpace above + * @param alpha2 floating point scaling factor, allocated on the host (input) + * @param zDesc Tensor descriptor for tensor z (input) + * @param z Data tensor z (input) + * @param biasDesc Tensor descriptor for input data tensor x (input) + * @param bias Data tensor bias (input) + * @param activationDesc Activation descriptor that specifies the activation mode + * @param yDesc Tensor descriptor for output data tensor y (input) + * @param y Output data tensor */ + MIOPEN_EXPORT miopenStatus_t miopenConvolutionBiasActivationForward(miopenHandle_t handle, const void* alpha1, @@ -4255,7 +4273,7 @@ MIOPEN_EXPORT miopenStatus_t miopenGetRNNPaddingMode(miopenRNNDescriptor_t rnnDe * * @param handle MIOpen handle (input) * @param rnnDesc RNN layer descriptor type (input) - * + * @param fwdMode Specifies in which mode the buffers will be used. * @param xDesc An input tensor descriptor for sequenced RNN data. This * miopenSeqTensorDescriptor_t should be initialyzed by `miopenSetRNNDataSeqTensorDescriptor` * function.(input)