[clang-tools-extra] r176712 - Fixing Doxygen warnings in cpp11-migrate
Edwin Vane
edwin.vane at intel.com
Fri Mar 8 11:12:12 PST 2013
Author: revane
Date: Fri Mar 8 13:12:12 2013
New Revision: 176712
URL: http://llvm.org/viewvc/llvm-project?rev=176712&view=rev
Log:
Fixing Doxygen warnings in cpp11-migrate
Turned on doxygen warnings and fixed the resulting problems.
Modified:
clang-tools-extra/trunk/cpp11-migrate/Cpp11Migrate.cpp
clang-tools-extra/trunk/cpp11-migrate/UseAuto/UseAutoMatchers.cpp
clang-tools-extra/trunk/docs/Doxyfile
Modified: clang-tools-extra/trunk/cpp11-migrate/Cpp11Migrate.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/cpp11-migrate/Cpp11Migrate.cpp?rev=176712&r1=176711&r2=176712&view=diff
==============================================================================
--- clang-tools-extra/trunk/cpp11-migrate/Cpp11Migrate.cpp (original)
+++ clang-tools-extra/trunk/cpp11-migrate/Cpp11Migrate.cpp Fri Mar 8 13:12:12 2013
@@ -11,19 +11,7 @@
/// \brief This file implements the C++11 feature migration tool main function
/// and transformation framework.
///
-/// Usage:
-/// cpp11-migrate [-p <build-path>] <file1> <file2> ... [-- [compiler-options]]
-///
-/// Where <build-path> is a CMake build directory containing a file named
-/// compile_commands.json which provides compiler options for building each
-/// sourc file. If <build-path> is not provided the compile_commands.json file
-/// is searched for through all parent directories.
-///
-/// Alternatively, one can provide compile options to be applied to every source
-/// file after the optional '--'.
-///
-/// <file1>... specify the paths of files in the CMake source tree, with the
-/// same requirements as other tools built on LibTooling.
+/// See user documentation for usage instructions.
///
//===----------------------------------------------------------------------===//
Modified: clang-tools-extra/trunk/cpp11-migrate/UseAuto/UseAutoMatchers.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/cpp11-migrate/UseAuto/UseAutoMatchers.cpp?rev=176712&r1=176711&r2=176712&view=diff
==============================================================================
--- clang-tools-extra/trunk/cpp11-migrate/UseAuto/UseAutoMatchers.cpp (original)
+++ clang-tools-extra/trunk/cpp11-migrate/UseAuto/UseAutoMatchers.cpp Fri Mar 8 13:12:12 2013
@@ -63,7 +63,7 @@ AST_MATCHER(VarDecl, hasWrittenNonListIn
/// class C {};
/// typedef C my_type
/// typedef my_type my_other_type;
-/// \code
+/// \endcode
///
/// \c qualType(isSugarFor(recordType(hasDeclaration(namedDecl(hasName("C"))))))
/// matches \c my_type and \c my_other_type.
@@ -88,7 +88,7 @@ AST_MATCHER_P(QualType, isSugarFor, inte
/// \code
/// iterator I;
/// const_iterator CI;
-/// \code
+/// \endcode
///
/// \c namedDecl(hasStdIteratorName()) matches \c I and \c CI.
AST_MATCHER(NamedDecl, hasStdIteratorName) {
@@ -116,7 +116,7 @@ AST_MATCHER(NamedDecl, hasStdIteratorNam
/// class vector {};
/// class forward_list {};
/// class my_vec {};
-/// \code
+/// \endcode
///
/// \c recordDecl(hasStdContainerName()) matches \c vector and \c forward_list
/// but not \c my_vec.
Modified: clang-tools-extra/trunk/docs/Doxyfile
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/Doxyfile?rev=176712&r1=176711&r2=176712&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/Doxyfile (original)
+++ clang-tools-extra/trunk/docs/Doxyfile Fri Mar 8 13:12:12 2013
@@ -601,13 +601,13 @@ QUIET = NO
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
-WARNINGS = NO
+WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
-WARN_IF_UNDOCUMENTED = NO
+WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
More information about the cfe-commits
mailing list