Residual SIMD Doxygen improvements
authorTeemu Murtola <teemu.murtola@gmail.com>
Mon, 27 Jan 2014 18:55:00 +0000 (20:55 +0200)
committerTeemu Murtola <teemu.murtola@gmail.com>
Fri, 28 Feb 2014 07:42:29 +0000 (09:42 +0200)
- Add a link to the overview documentation from the module page.
- Remove some trailing spaces.

Some issues noted, but not fixed here:
- \nosubgrouping would make the file pages look more consistent, if it
  worked for files...
- Some of the SIMD routines are not included in any named group, making
  them appear separately at the end of the documentation.
- The list of members on the SIMD module page is exceedingly long,
  making it hard to find things there.  Would require some thinking on
  how to best solve this.

Change-Id: I628f321172a3c3e8f4874e166c48e12763d1490e

doxygen/directories.cpp
src/gromacs/simd/simd.h

index eeab018d40194623a141a4af813e5f2d6079079d..13de5ee37731f3dfd33eb0f30c902e3eeb0c0a52 100644 (file)
@@ -90,13 +90,13 @@ Doxygen documentation file for directories in the source tree.
 /*! \libinternal
 \dir src/gromacs/simd
 \brief \ref module_simd
+
 \ingroup module_simd
  */
 /*! \libinternal
 \dir src/gromacs/simd/tests
 \brief Unit tests for \ref module_simd
+
 \ingroup module_simd
  */
 
index 0e8716a9929175fa7053ba0a345fa4c2013c3df5..291cbb1c8c19778e234b97792e0be7dffd5cd3d9 100644 (file)
  */
 
 /*! \libinternal
- *  \defgroup module_simd SIMD intrinsics interface (simd)
- *  \ingroup group_utilitymodules
+ * \defgroup module_simd SIMD intrinsics interface (simd)
+ * \ingroup group_utilitymodules
  *
- *  \brief Provides an architecture-independent way of doing SIMD coding.
+ * \brief Provides an architecture-independent way of doing SIMD coding.
  *
- *  Start by consulting the overview Doxygen SIMD module documentation which is
- *  available in the internal library documentation (but not the public API),
- *  and then the details are documented in simd.h and the reference
- *  implementation impl_reference.h.
+ * Overview of the SIMD implementation is provided in \ref page_simd.
+ * The details are documented in simd.h and the reference implementation
+ * impl_reference.h.
  *
- *  \author Erik Lindahl <erik.lindahl@scilifelab.se>
+ * \author Erik Lindahl <erik.lindahl@scilifelab.se>
  */
 
 #ifndef GMX_SIMD_SIMD_H