replica
/
hanchenye-llvm-project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixing Doxygen warnings in cpp11-migrate 

Turned on doxygen warnings and fixed the resulting problems.

llvm-svn: 176712
This commit is contained in:
Edwin Vane 2013-03-08 19:12:12 +00:00
parent 7e4844b353
commit fac739a357
3 changed files with 6 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
clang-tools-extra/cpp11-migrate/Cpp11Migrate.cpp
View File

@ -11,19 +11,7 @@
/// \brief This file implements the C++11 feature migration tool main function /// \brief This file implements the C++11 feature migration tool main function
/// and transformation framework. /// and transformation framework.
/// ///
/// Usage: /// See user documentation for usage instructions.
/// 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.
/// ///
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//

6
clang-tools-extra/cpp11-migrate/UseAuto/UseAutoMatchers.cpp
View File

@ -63,7 +63,7 @@ AST_MATCHER(VarDecl, hasWrittenNonListInitializer) {
/// class C {}; /// class C {};
/// typedef C my_type /// typedef C my_type
/// typedef my_type my_other_type; /// typedef my_type my_other_type;
/// \code /// \endcode
/// ///
/// \c qualType(isSugarFor(recordType(hasDeclaration(namedDecl(hasName("C")))))) /// \c qualType(isSugarFor(recordType(hasDeclaration(namedDecl(hasName("C"))))))
/// matches \c my_type and \c my_other_type. /// matches \c my_type and \c my_other_type.
@ -88,7 +88,7 @@ AST_MATCHER_P(QualType, isSugarFor, internal::Matcher<QualType>, SugarMatcher) {
/// \code /// \code
/// iterator I; /// iterator I;
/// const_iterator CI; /// const_iterator CI;
/// \code /// \endcode
/// ///
/// \c namedDecl(hasStdIteratorName()) matches \c I and \c CI. /// \c namedDecl(hasStdIteratorName()) matches \c I and \c CI.
AST_MATCHER(NamedDecl, hasStdIteratorName) { AST_MATCHER(NamedDecl, hasStdIteratorName) {
@ -116,7 +116,7 @@ AST_MATCHER(NamedDecl, hasStdIteratorName) {
/// class vector {}; /// class vector {};
/// class forward_list {}; /// class forward_list {};
/// class my_vec {}; /// class my_vec {};
/// \code /// \endcode
/// ///
/// \c recordDecl(hasStdContainerName()) matches \c vector and \c forward_list /// \c recordDecl(hasStdContainerName()) matches \c vector and \c forward_list
/// but not \c my_vec. /// but not \c my_vec.

4
clang-tools-extra/docs/Doxyfile
View File

@ -601,13 +601,13 @@ QUIET = NO
# generated by doxygen. Possible values are YES and NO. If left blank # generated by doxygen. Possible values are YES and NO. If left blank
# NO is used. # NO is used.
WARNINGS = NO WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # 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 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled. # 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 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some # potential errors in the documentation, such as not documenting some