Merge "Fix a few doxygen warnings."
authorChristoph Junghans <junghans@votca.org>
Sat, 28 Jul 2012 23:52:23 +0000 (01:52 +0200)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Sat, 28 Jul 2012 23:52:23 +0000 (01:52 +0200)
src/gromacs/legacyheaders/gmx_fatal.h
src/gromacs/legacyheaders/thread_mpi/numa_malloc.h

index 5027a3e34261047ae653f60d06d017e9a41053e4..faea213c91c97f8d6921c59ba065785a7f77ee31 100644 (file)
@@ -50,7 +50,10 @@ extern "C" {
 #define __has_feature(x) 0 // Compatibility with non-clang compilers.
 #endif
 
-/*! \def GMX_ATTRIBUTE_NORETURN
+/* This documentation block seems to produce warnings with some Doxygen
+ * versions, so it's disabled for now.  Maybe because the file itself
+ * is not documented. */
+/* \def GMX_ATTRIBUTE_NORETURN
  * \brief
  * Indicate that a function is not expected to return.
  *
index 63218bb02320c3bc979dc4e1bab3f82a9c8a81c3..10331245598484a16a283533beefca1ffe78e298 100644 (file)
@@ -51,9 +51,11 @@ files.
    
     Currently this is only implemented on Windows. Check for the presence
     of these functions with
+    \code
     #ifdef TMPI_NUMA_MALLOC
     ....
     #endif
+    \endcode
  */