changeset 571:c79a501782b0

Docs: add misc/ folder to Doxygen
author David Demelier <markand@malikania.fr>
date Wed, 29 Jun 2016 19:18:39 +0200
parents dcef88285f8c
children ad302d1b7335
files cmake/Doxyfile.in misc/clamp.hpp misc/join.hpp misc/strip.hpp
diffstat 4 files changed, 16 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/cmake/Doxyfile.in	Wed Jun 29 19:12:10 2016 +0200
+++ b/cmake/Doxyfile.in	Wed Jun 29 19:18:39 2016 +0200
@@ -754,7 +754,7 @@
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_SOURCE_DIR@/modules/
+INPUT                  = @CMAKE_SOURCE_DIR@/modules/ @CMAKE_SOURCE_DIR@/misc
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
--- a/misc/clamp.hpp	Wed Jun 29 19:12:10 2016 +0200
+++ b/misc/clamp.hpp	Wed Jun 29 19:18:39 2016 +0200
@@ -16,6 +16,11 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file clamp.hpp
+ * \brief Clamp function
+ */
+
 #include <algorithm>
 
 /**
--- a/misc/join.hpp	Wed Jun 29 19:12:10 2016 +0200
+++ b/misc/join.hpp	Wed Jun 29 19:18:39 2016 +0200
@@ -17,6 +17,11 @@
  */
 
 /**
+ * \file join.hpp
+ * \brief Join function
+ */
+
+/**
  * Join values by a separator and return a string.
  *
  * \param first the first iterator
--- a/misc/strip.hpp	Wed Jun 29 19:12:10 2016 +0200
+++ b/misc/strip.hpp	Wed Jun 29 19:18:39 2016 +0200
@@ -16,6 +16,11 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/**
+ * \file strip.hpp
+ * \brief Strip function
+ */
+
 #include <algorithm>
 #include <cctype>