remove doxygen warnings

syurkevi · umar456 · commit 461b694d5dd1 · 2023-01-24T00:35:56.000-05:00
diff --git a/docs/details/arith.dox b/docs/details/arith.dox
@@ -230,11 +230,6 @@ Find the modulus.
 
 Find the absolute value.
 
-__Examples:__
-
-\snippet test/math.cpp ex_arith_func_abs
-
-
 
 \defgroup arith_func_arg arg
 \ingroup numeric_mat
@@ -332,11 +327,6 @@ Evaluate the inverse cosine function (arc cosine).
 
 The inverse of cosine so that, if `y = cos(x)`, then `x = arccos(y)`.
 
-__Examples:__
-
-\snippet test/math.cpp ex_arith_func_acos
-
-
 
 \defgroup arith_func_atan atan/atan2
 \ingroup trig_mat
@@ -440,7 +430,7 @@ Raise a base to a power (or exponent).
 
 
 
-\defgroup arith_func_pow pow2
+\defgroup arith_func_pow2 pow2
 \ingroup explog_mat
 
 Raise 2 to a power (or exponent).
diff --git a/docs/details/image.dox b/docs/details/image.dox
@@ -855,7 +855,7 @@ is described above, but the effect should be the same.
 \defgroup image_func_wrap wrap
 \ingroup image_mod_mat
 
-Performs the opposite of \ref unwrap().
+Performs the opposite of \ref af::unwrap().
 
 More specifically, wrap takes each column (or row if `is_column` is false) of the
 \f$m \times n\f$ input array and reshapes them into `wx` \f$\times\f$ `wy`
@@ -935,7 +935,7 @@ is visualized above, but the effect should be the same.
 \defgroup image_func_moments moments
 \ingroup moments_mat
 
-The \ref moments() function allows for finding different
+The \ref af::moments() function allows for finding different
 properties of image regions. Currently, ArrayFire calculates all first order moments.
 The moments are defined within the \ref af_moment_type enum.
 
@@ -1059,8 +1059,8 @@ explicitly.
 
 \brief Segment image based on similar pixel characteristics
 
-This filter is similar to \ref regions() (connected components) with additional
-criteria for segmentation. In \ref regions(), all connected (\ref af_connectivity)
+This filter is similar to \ref af::regions() (connected components) with additional
+criteria for segmentation. In \ref af::regions(), all connected (\ref af_connectivity)
 pixels connected are considered to be a single component. In this
 variation of connected components, pixels having similar pixel statistics
 of the neighborhoods around a given set of seed points are grouped together.
diff --git a/docs/details/lapack.dox b/docs/details/lapack.dox
@@ -141,7 +141,7 @@ following code snippet can be used:
 
 \snippet test/svd_dense.cpp ex_svd_reg
 
-When memory is a concern, and \f$A\f$ is dispensable, \ref svdInPlace() can be
+When memory is a concern, and \f$A\f$ is dispensable, \ref af::svdInPlace() can be
 used. However, this in-place version is currently limited to input arrays where
 \f$M \geq N\f$.
 
diff --git a/docs/details/signal.dox b/docs/details/signal.dox
@@ -274,7 +274,7 @@ Given below is an example of this batch mode.
 
 
 The batching behavior of convolve2NN functions(\ref af_convolve2_nn() and
-\ref convolve2NN() ) is different from convolve2. The new functions can perform 2D
+\ref af::convolve2NN() ) is different from convolve2. The new functions can perform 2D
 convolution on 3D signals and filters in a way that is more aligned with
 convolutional neural networks.
 
diff --git a/docs/pages/getting_started.md b/docs/pages/getting_started.md
@@ -18,7 +18,7 @@ achieve high throughput on most parallel architectures.
 
 ArrayFire provides one generic container object, the [array](\ref af::array)
 on which functions and mathematical operations are performed. The `array`
-can represent one of many different [basic data types](\ref af::af_dtype):
+can represent one of many different [basic data types](\ref af_dtype):
 
 * [f32](\ref f32) real single-precision (`float`)
 * [c32](\ref c32) complex single-precision (`cfloat`)
@@ -87,7 +87,7 @@ ArrayFire provides several functions to determine various aspects of arrays.
 This includes functions to print the contents, query the dimensions, and
 determine various other aspects of arrays.
 
-The [af_print](\ref af::af_print) function can be used to print arrays that
+The [af_print](\ref af_print) function can be used to print arrays that
 have already been generated or any expression involving arrays:
 
 \snippet test/getting_started.cpp ex_getting_started_print
diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
@@ -1217,7 +1217,7 @@ Bug Fixes
       before returning pointer with asynchronous calls in CPU backend.
     * OpenCL Backend: [fix segfaults](https://github.com/arrayfire/arrayfire/issues/1324)
       when requested for device pointers on empty arrays.
-* Fixed \ref af::array::operator%() from using [rem to mod](https://github.com/arrayfire/arrayfire/issues/1318).
+* Fixed \ref af::operator%() from using [rem to mod](https://github.com/arrayfire/arrayfire/issues/1318).
 * Fixed [array destruction](https://github.com/arrayfire/arrayfire/issues/1321)
   when backends are switched in Unified API.
 * Fixed [indexing](https://github.com/arrayfire/arrayfire/issues/1331) after
@@ -1356,9 +1356,9 @@ Deprecations
 Documentation
 --------------
 
-* Fixes to documentation for \ref matchTemplate().
+* Fixes to documentation for \ref af::matchTemplate().
 * Improved documentation for deviceInfo.
-* Fixes to documentation for \ref exp().
+* Fixes to documentation for \ref af::exp().
 
 Known Issues
 ------------
@@ -1497,18 +1497,18 @@ Major Updates
 Function Additions
 ------------------
 * Unified Backend
-    * \ref setBackend() - Sets a backend as active
-    * \ref getBackendCount() - Gets the number of backends available for use
-    * \ref getAvailableBackends() - Returns information about available backends
-    * \ref getBackendId() - Gets the backend enum for an array
+    * \ref af::setBackend() - Sets a backend as active
+    * \ref af::getBackendCount() - Gets the number of backends available for use
+    * \ref af::getAvailableBackends() - Returns information about available backends
+    * \ref af::getBackendId() - Gets the backend enum for an array
 
 * Vision
-    * \ref homography() - Homography estimation
-    * \ref gloh() - GLOH Descriptor for SIFT
+    * \ref af::homography() - Homography estimation
+    * \ref af::gloh() - GLOH Descriptor for SIFT
 
 * Image Processing
-    * \ref loadImageNative() - Load an image as native data without modification
-    * \ref saveImageNative() - Save an image without modifying data or type
+    * \ref af::loadImageNative() - Load an image as native data without modification
+    * \ref af::saveImageNative() - Save an image without modifying data or type
 
 * Graphics
     * \ref af::Window::plot3() - 3-dimensional line plot
@@ -1522,26 +1522,26 @@ Function Additions
     * \ref af_release_indexers()
 
 * CUDA Backend Specific
-    * \ref setNativeId() - Set the CUDA device with given native id as active
+    * \ref afcu::setNativeId() - Set the CUDA device with given native id as active
         * ArrayFire uses a modified order for devices. The native id for a
           device can be retreived using `nvidia-smi`
 
 * OpenCL Backend Specific
-    * \ref setDeviceId() - Set the OpenCL device using the `clDeviceId`
+    * \ref afcl::setDeviceId() - Set the OpenCL device using the `clDeviceId`
 
 Other Improvements
 ------------------------
-* Added \ref c32 and \ref c64 support for \ref isNaN(), \ref isInf() and \ref iszero()
-* Added CPU information for `x86` and `x86_64` architectures in CPU backend's \ref info()
-* Batch support for \ref approx1() and \ref approx2()
+* Added \ref c32 and \ref c64 support for \ref af::isNaN(), \ref af::isInf() and \ref af::iszero()
+* Added CPU information for `x86` and `x86_64` architectures in CPU backend's \ref af::info()
+* Batch support for \ref af::approx1() and \ref af::approx2()
     * Now can be used with gfor as well
 * Added \ref s64 and \ref u64 support to:
-    * \ref sort() (along with sort index and sort by key)
-    * \ref setUnique(), \ref setUnion(), \ref setIntersect()
-    * \ref convolve() and \ref fftConvolve()
-    * \ref histogram() and \ref histEqual()
-    * \ref lookup()
-    * \ref mean()
+    * \ref af::sort() (along with sort index and sort by key)
+    * \ref af::setUnique(), \ref af::setUnion(), \ref af::setIntersect()
+    * \ref af::convolve() and \ref af::fftConvolve()
+    * \ref af::histogram() and \ref af::histEqual()
+    * \ref af::lookup()
+    * \ref af::mean()
 * Added \ref AF_MSG macro
 
 Build Improvements
@@ -1553,15 +1553,15 @@ Build Improvements
 
 Bug Fixes
 --------------
-* Fixed [memory leak](https://github.com/arrayfire/arrayfire/pull/1096) in \ref susan()
+* Fixed [memory leak](https://github.com/arrayfire/arrayfire/pull/1096) in \ref af::susan()
 * Fixed [failing test](https://github.com/arrayfire/arrayfire/commit/144a2db)
-  in \ref lower() and \ref upper() for CUDA compute 53
+  in \ref af::lower() and \ref af::upper() for CUDA compute 53
 * Fixed [bug](https://github.com/arrayfire/arrayfire/issues/1092) in CUDA for indexing out of bounds
-* Fixed [dims check](https://github.com/arrayfire/arrayfire/commit/6975da8) in \ref iota()
-* Fixed [out-of-bounds access](https://github.com/arrayfire/arrayfire/commit/7fc3856) in \ref sift()
-* Fixed [memory allocation](https://github.com/arrayfire/arrayfire/commit/5e88e4a) in \ref fast() OpenCL
+* Fixed [dims check](https://github.com/arrayfire/arrayfire/commit/6975da8) in \ref af::iota()
+* Fixed [out-of-bounds access](https://github.com/arrayfire/arrayfire/commit/7fc3856) in \ref af::sift()
+* Fixed [memory allocation](https://github.com/arrayfire/arrayfire/commit/5e88e4a) in \ref af::fast() OpenCL
 * Fixed [memory leak](https://github.com/arrayfire/arrayfire/pull/994) in image I/O functions
-* \ref dog() now returns float-point type arrays
+* \ref af::dog() now returns float-point type arrays
 
 Documentation Updates
 ---------------------
@@ -1664,10 +1664,10 @@ v3.1.0
 Function Additions
 ------------------
 * Computer Vision Functions
-    * \ref nearestNeighbour() - Nearest Neighbour with SAD, SSD and SHD distances
-    * \ref harris() - Harris Corner Detector
-    * \ref susan() - Susan Corner Detector
-    * \ref sift() - Scale Invariant Feature Transform (SIFT)
+    * \ref af::nearestNeighbour() - Nearest Neighbour with SAD, SSD and SHD distances
+    * \ref af::harris() - Harris Corner Detector
+    * \ref af::susan() - Susan Corner Detector
+    * \ref af::sift() - Scale Invariant Feature Transform (SIFT)
         * Method and apparatus for identifying scale invariant features"
           "in an image and use of same for locating an object in an image,\" David"
           "G. Lowe, US Patent 6,711,293 (March 23, 2004). Provisional application"
@@ -1677,7 +1677,7 @@ Function Additions
           "Columbia.")
         * SIFT is available for compiling but does not ship with ArrayFire
           hosted installers/pre-built libraries
-    * \ref dog() -  Difference of Gaussians
+    * \ref af::dog() -  Difference of Gaussians
 
 * Image Processing Functions
     * \ref ycbcr2rgb() and \ref rgb2ycbcr() - RGB <->YCbCr color space conversion
@@ -1803,20 +1803,20 @@ Bug Fixes
 --------------
 
 * Added missing symbols from the compatible API
-* Fixed a bug affecting corner rows and elements in \ref grad()
+* Fixed a bug affecting corner rows and elements in \ref af::grad()
 * Fixed linear interpolation bugs affecting large images in the following:
-    - \ref approx1()
-    - \ref approx2()
-    - \ref resize()
-    - \ref rotate()
-    - \ref scale()
-    - \ref skew()
-    - \ref transform()
+    - \ref af::approx1()
+    - \ref af::approx2()
+    - \ref af::resize()
+    - \ref af::rotate()
+    - \ref af::scale()
+    - \ref af::skew()
+    - \ref af::transform()
 
 Documentation
 -----------------
 
-* Added missing documentation for \ref constant()
+* Added missing documentation for \ref af::constant()
 * Added missing documentation for `array::scalar()`
 * Added supported input types for functions in `arith.h`
 
diff --git a/docs/pages/using_on_linux.md b/docs/pages/using_on_linux.md
@@ -8,7 +8,7 @@ requirements are that you include the ArrayFire header directories and link with
 the ArrayFire library you intend to use i.e. CUDA, OpenCL, CPU, or Unified
 backends.
 
-## The big picture  {#big-picture}
+## The big picture  {#big-picture-linux}
 
 On Linux, we recommend installing ArrayFire to `/opt/arrayfire` directory. The
 installer will populate files in the following sub-directories:
@@ -57,7 +57,7 @@ apt install build-essential cmake cmake-curses-gui
 ## CMake
 
 We recommend that the CMake build system be used to create ArrayFire projects.
-As [discussed above](#big-picture), ArrayFire ships with a series of CMake
+As [discussed above](#big-picture-linux), ArrayFire ships with a series of CMake
 scripts to make finding and using our library easy.
 
 First create a file called `CMakeLists.txt` in your project directory:
diff --git a/docs/pages/using_on_osx.md b/docs/pages/using_on_osx.md
@@ -7,7 +7,7 @@ project using almost any editor, compiler, or build system. The only requirement
 is that you can include the ArrayFire header directory, and link with the
 ArrayFire library you intend to use.
 
-## <a name="big-picture"/> The big picture
+## The big picture {#big-picture-osx}
 
 By default, the ArrayFire OSX installer will place several files in your
 computer's `/opt/arrayfire` directory. The installer will populate this
@@ -33,7 +33,7 @@ CMake or Makefiles with CMake being our preferred build system.
 ## CMake {#CMake}
 
 The CMake build system can be used to create ArrayFire projects. As [discussed
-above](#big-picture), ArrayFire ships with a series of CMake scripts to make
+above](#big-picture-osx), ArrayFire ships with a series of CMake scripts to make
 finding and using our library easy.
 
 First create a file called `CMakeLists.txt` in your project directory:
diff --git a/docs/pages/using_on_windows.md b/docs/pages/using_on_windows.md
@@ -4,7 +4,7 @@ Using ArrayFire with Microsoft Windows and Visual Studio {#using_on_windows}
 If you have not already done so, please make sure you have installed,
 configured, and tested ArrayFire following the [installation instructions](#installing).
 
-# The big picture
+# The big picture {#big-picture-windows}
 
 The ArrayFire Windows installer creates the following:
 1. **AF_PATH** environment variable to point to the installation location. The
diff --git a/include/af/image.h b/include/af/image.h
@@ -602,7 +602,7 @@ AFAPI array unwrap(const array& in, const dim_t wx, const dim_t wy,
 
 #if AF_API_VERSION >= 31
 /**
-   C++ Interface for performing the opposite of \ref unwrap()
+   C++ Interface for performing the opposite of \ref unwrap
 
    \param[in]  in is the input array
    \param[in]  ox is the output's dimension 0 size
@@ -1487,7 +1487,7 @@ extern "C" {
 
 #if AF_API_VERSION >= 31
     /**
-       C Interface for performing the opposite of \ref unwrap()
+       C Interface for performing the opposite of \ref af::unwrap()
 
        \param[out] out is an array with the input's columns (or rows) reshaped as
                    patches
@@ -1506,7 +1506,7 @@ extern "C" {
        otherwise an appropriate error code is returned.
 
        \note Wrap is typically used to recompose an unwrapped image. If this is the
-             case, use the same parameters that were used in \ref unwrap(). Also
+             case, use the same parameters that were used in \ref af::unwrap(). Also
              use the original image size (before unwrap) for \p ox and \p oy.
        \note The window/patch size, \p wx \f$\times\f$ \p wy, must equal
              `input.dims(0)` (or `input.dims(1)` if \p is_column is false).
@@ -1552,7 +1552,7 @@ extern "C" {
        otherwise an appropriate error code is returned.
 
        \note Wrap is typically used to recompose an unwrapped image. If this is the
-             case, use the same parameters that were used in \ref unwrap(). Also
+             case, use the same parameters that were used in \ref af::unwrap(). Also
              use the original image size (before unwrap) for \p ox and \p oy.
        \note The window/patch size, \p wx \f$\times\f$ \p wy, must equal
              `input.dims(0)` (or `input.dims(1)` if \p is_column is false).
diff --git a/include/af/ml.h b/include/af/ml.h
@@ -20,7 +20,7 @@ class dim4;
     /**
         C++ interface for calculating backward pass gradient of 2D convolution
         This function calculates the gradient with respect to the output
-        of the \ref convolve2NN() function that uses the machine learning
+        of the \ref convolve2NN function that uses the machine learning
         formulation for the dimensions of the signals and filters
 
         \param[in]  incoming_gradient gradients to be distributed in backwards pass
@@ -60,7 +60,7 @@ extern "C" {
     /**
         C interface for calculating backward pass gradient of 2D convolution
         This function calculates the gradient with respect to the output
-        of the \ref convolve2NN() function that uses the machine learning
+        of the \ref af::convolve2NN() function that uses the machine learning
         formulation for the dimensions of the signals and filters
 
         \param[out] out gradient wrt/gradType
diff --git a/include/af/util.h b/include/af/util.h
@@ -184,7 +184,7 @@ extern "C" {
 #if AF_API_VERSION >= 31
     /**
         \param[out] index is the index location of the array in the file
-        \param[in] key is an expression used as tag/key for the array during \ref readArray()
+        \param[in] key is an expression used as tag/key for the array during \ref af::readArray()
         \param[in] arr is the array to be written
         \param[in] filename is the path to the location on disk
         \param[in] append is used to append to an existing file when true and create or
diff --git a/test/complex.cpp b/test/complex.cpp
