diff options
author | James Dennett <jdennett@google.com> | 2013-01-23 00:45:44 +0000 |
---|---|---|
committer | James Dennett <jdennett@google.com> | 2013-01-23 00:45:44 +0000 |
commit | f8317679cb2dab9d06835e05bd5d69c0bd8f491f (patch) | |
tree | 94d453cd2aac1f6dd2cf6fe4a592b00f697770fc /clang/lib/Frontend/FrontendAction.cpp | |
parent | 706eedb1b96367961f6897d6cce7a7d45d9488eb (diff) | |
download | bcm5719-llvm-f8317679cb2dab9d06835e05bd5d69c0bd8f491f.tar.gz bcm5719-llvm-f8317679cb2dab9d06835e05bd5d69c0bd8f491f.zip |
Documentation cleanup: fixing documentation for FrontendAction.
* Fix a typo, s/BeginSourceAction/BeginSourceFile/, so that the documentation
for FrontendAction::BeginSourceFileAction links correctly to BeginSourceFile;
* Add some basic \file documentation for FrontendAction.h;
* More use of "\brief" instead of repeating the name of the entity being
documented;
* Stop using Doxygen-style "///" comments in FrontendAction.cpp, as they were
polluting the documentation for BeginSourceFile;
* Drop incorrect "\see" markup that broke Doxygen's formatting;
* Other minor documentation fixes.
llvm-svn: 173213
Diffstat (limited to 'clang/lib/Frontend/FrontendAction.cpp')
-rw-r--r-- | clang/lib/Frontend/FrontendAction.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/clang/lib/Frontend/FrontendAction.cpp b/clang/lib/Frontend/FrontendAction.cpp index 9ff7a66248e..742caf158ba 100644 --- a/clang/lib/Frontend/FrontendAction.cpp +++ b/clang/lib/Frontend/FrontendAction.cpp @@ -198,7 +198,7 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI, if (!BeginSourceFileAction(CI, InputFile)) goto failure; - /// Create the AST consumer. + // Create the AST consumer. CI.setASTConsumer(CreateWrappedASTConsumer(CI, InputFile)); if (!CI.hasASTConsumer()) goto failure; @@ -279,8 +279,8 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI, if (!BeginSourceFileAction(CI, InputFile)) goto failure; - /// Create the AST context and consumer unless this is a preprocessor only - /// action. + // Create the AST context and consumer unless this is a preprocessor only + // action. if (!usesPreprocessorOnly()) { CI.createASTContext(); |