[arrayfire] 07/61: Fix documentation when using older doxygen
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Tue Dec 8 11:54:55 UTC 2015
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch dfsg-clean
in repository arrayfire.
commit ef2e7d7bfe7a363c737ed93b3afaf917cba51ed0
Author: Shehzan Mohammed <shehzan at arrayfire.com>
Date: Sat Nov 21 12:11:40 2015 -0500
Fix documentation when using older doxygen
* Eliminate dummy groups
* Remove repeats of operator() groups
---
docs/details/array.dox | 21 -------------
include/af/array.h | 80 +++++++++++++++++++++++++++++++-------------------
2 files changed, 49 insertions(+), 52 deletions(-)
diff --git a/docs/details/array.dox b/docs/details/array.dox
index a58955c..2f696a2 100644
--- a/docs/details/array.dox
+++ b/docs/details/array.dox
@@ -16,27 +16,6 @@ to \ref af::array objects.
===============================================================================
-\defgroup array_mem_operator_paren_one operator()
-
-This operator returns a reference of the original array at a given coordinate.
-You can pass \ref af::seq, \ref af::array, or an int as it's parameters. These
-references can be used for assignment or returning references
-to \ref af::array objects.
-
-If the \ref af::array is a multi-dimensional array then this coordinate
-will treated as the data as a linear array.
-
-===============================================================================
-
-\defgroup array_mem_operator_paren_many operator()
-
-This operator returns a reference of the original array at a given coordinate.
-You can pass \ref af::seq, \ref af::array, or an int as it's parameters. These
-references can be used for assignment or returning references
-to \ref af::array objects.
-
-===============================================================================
-
\defgroup array_mem_row row/rows
\ingroup index_mat
diff --git a/include/af/array.h b/include/af/array.h
index a5f39e7..193cf8d 100644
--- a/include/af/array.h
+++ b/include/af/array.h
@@ -683,47 +683,65 @@ namespace af
// INDEXING
// Single arguments
+ /**
+ \brief This operator returns a reference of the original array at a given coordinate.
- /// \ingroup array_mem_operator_paren
- /// @{
- ///
- /// \brief Gets a reference to a set of linear elements
- ///
- /// \copydetails array_mem_operator_paren_one
- ///
- /// \param[in] s0 is sequence of linear indices
- ///
- /// \returns A reference to the array at the given index
- ///
- array::array_proxy operator()(const index &s0);
+ You can pass \ref af::seq, \ref af::array, or an int as it's parameters.
+ These references can be used for assignment or returning references
+ to \ref af::array objects.
+
+ If the \ref af::array is a multi-dimensional array then this coordinate
+ will treated as the data as a linear array.
+
+ \param[in] s0 is sequence of linear indices
- /// \copydoc operator()(const index &)
+ \returns A reference to the array at the given index
+
+ \ingroup array_mem_operator_paren
+
+ */
+ array::array_proxy operator()(const index &s0);
+
+ /**
+ \copydoc operator()(const index &)
+
+ \ingroup array_mem_operator_paren
+ */
const array::array_proxy operator()(const index &s0) const;
- ///
- /// \brief Gets a reference to a sub array
- ///
- /// \copydetails array_mem_operator_paren_many
- ///
- /// \param[in] s0 is sequence of indices along the first dimension
- /// \param[in] s1 is sequence of indices along the second dimension
- /// \param[in] s2 is sequence of indices along the third dimension
- /// \param[in] s3 is sequence of indices along the fourth dimension
- ///
- /// \returns A reference to the array at the given index
- ///
- array::array_proxy operator()(const index &s0,
- const index &s1,
- const index &s2 = span,
- const index &s3 = span);
+ /**
+ \brief This operator returns a reference of the original array at a
+ given coordinate.
+
+ You can pass \ref af::seq, \ref af::array, or an int as it's parameters.
+ These references can be used for assignment or returning references
+ to \ref af::array objects.
+
+ \param[in] s0 is sequence of indices along the first dimension
+ \param[in] s1 is sequence of indices along the second dimension
+ \param[in] s2 is sequence of indices along the third dimension
+ \param[in] s3 is sequence of indices along the fourth dimension
- /// \copydoc operator()(const index &, const index &, const index &, const index &)
+ \returns A reference to the array at the given index
+
+ \ingroup array_mem_operator_paren
+ */
+ array::array_proxy operator()(const index &s0,
+ const index &s1,
+ const index &s2 = span,
+ const index &s3 = span);
+
+ /**
+ \copydoc operator()(const index &, const index &, const index &, const index &)
+
+ \ingroup array_mem_operator_paren
+ */
const array::array_proxy operator()(const index &s0,
const index &s1,
const index &s2 = span,
const index &s3 = span) const;
- /// @}
+
/// \ingroup array_mem_row
/// @{
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/arrayfire.git
More information about the debian-science-commits
mailing list