docs: update doxygen configuration
Most notably:
- disable OPTIMIZE_OUTPUT_FOR_C, this is a C++ project
- enable sorting of brief descriptions of class members
- stop generating documentation for detail headers (not installed)
Change-Id: Ie0608888f53f9b38f0a6e09cf198981cd7474109
diff --git a/src/common.hpp b/src/common.hpp
index b4d70d8..f9ceeb7 100644
--- a/src/common.hpp
+++ b/src/common.hpp
@@ -1,5 +1,5 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
+/*
* Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
@@ -21,8 +21,8 @@
/** \file
* \brief import common constructs for ndn-cxx library internal use
- * \warning This file is implementation detail of ndn-cxx library.
- * Aliases imported in this file SHOULD NOT be used outside of ndn-cxx.
+ * \warning This file is an implementation detail of ndn-cxx library.
+ * Aliases imported in this file MUST NOT be used outside of ndn-cxx.
*/
#ifndef NDN_COMMON_HPP
@@ -92,8 +92,10 @@
} // namespace ndn
-// Bug 2109 workaround
using namespace std::placeholders;
+
+/// \cond
+// Bug 2109 workaround
#define BOOST_BIND_NO_PLACEHOLDERS
#include <boost/is_placeholder.hpp>
namespace boost {
@@ -116,6 +118,7 @@
NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(9)
#undef NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER
} // namespace boost
+/// \endcond
#include <boost/assert.hpp>
#include <boost/concept_check.hpp>
diff --git a/src/security/transform/transform-base.hpp b/src/security/transform/transform-base.hpp
index a06f0b1..aca3a00 100644
--- a/src/security/transform/transform-base.hpp
+++ b/src/security/transform/transform-base.hpp
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2013-2016 Regents of the University of California.
+/*
+ * Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
@@ -30,7 +30,7 @@
namespace transform {
/**
- * @file transform-base.hpp
+ * @file
*
* There are three types of module in a transformation chain: Source, Transform, and Sink.
* The ideal usage of the transformation would be:
diff --git a/src/util/backports-optional.hpp b/src/util/backports-optional.hpp
index d00cb60..29862b1 100644
--- a/src/util/backports-optional.hpp
+++ b/src/util/backports-optional.hpp
@@ -1,5 +1,5 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
+/*
* Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
diff --git a/src/util/backports-ostream-joiner.hpp b/src/util/backports-ostream-joiner.hpp
index 384f24a..24a161c 100644
--- a/src/util/backports-ostream-joiner.hpp
+++ b/src/util/backports-ostream-joiner.hpp
@@ -1,5 +1,5 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
+/*
* Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
diff --git a/src/util/signal-emit.hpp b/src/util/signal-emit.hpp
index 17eacd0..a28872c 100644
--- a/src/util/signal-emit.hpp
+++ b/src/util/signal-emit.hpp
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2013-2014 Regents of the University of California.
+/*
+ * Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*