Skip to content

Commit 60e58c3

Browse files
committed
Add a dedicated fake header for doxygen
1 parent a339483 commit 60e58c3

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

Doxyfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,8 @@ FILE_PATTERNS = *.c \
620620
*.f90 \
621621
*.f \
622622
*.vhd \
623-
*.vhdl
623+
*.vhdl \
624+
*.dox
624625

625626
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
626627
# should be searched for input files as well. Possible values are YES and NO.

util/CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ endif()
5353

5454
add_custom_target(util
5555
SOURCES
56+
Documentation.dox
5657
${UTIL_HEADERS})
5758

5859
add_custom_target(util-DataStructures

util/Documentation.dox

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/*
2+
@author
3+
Ryan Pavlik
4+
5+
http://academic.cleardefinition.com/
6+
Iowa State University Virtual Reality Applications Center
7+
Human-Computer Interaction Graduate Program
8+
*/
9+
10+
// Copyright Iowa State University 2012.
11+
// Distributed under the Boost Software License, Version 1.0.
12+
// (See accompanying file LICENSE_1_0.txt or copy at
13+
// http://www.boost.org/LICENSE_1_0.txt)
14+
15+
// Internal Includes
16+
// - none
17+
18+
// Library/third-party includes
19+
// - none
20+
21+
// Standard includes
22+
// - none
23+
24+
namespace util {
25+
///
26+
/** @addtogroup Metaprogramming
27+
28+
@brief Tools to work with compile-time structures, template meta-programming,
29+
and Boost MPL.
30+
31+
Useful associated references:
32+
33+
Boost MPL documentation: http://www.boost.org/doc/libs/1_51_0/libs/mpl/
34+
35+
Book: "C++ Template Metaprogramming", by David Abrahams and Aleksey Gurtovoy, ISBN 0321227255
36+
Available online to Iowa State University users at http://proquest.safaribooksonline.com.proxy.lib.iastate.edu/book/programming/cplusplus/0321227255
37+
38+
*/
39+
/// @{
40+
/// @}
41+
}

0 commit comments

Comments
 (0)