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 | 18f43a62134eca1cd830a5b289f4bee4e6ee42fe (patch) | |
tree | 2a094084d07a5cc91fc18b05eac8fc00b133adea /lib/Frontend | |
parent | 909b6ded6be68a5740d98b478454fa55ea817ad6 (diff) |
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.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@173213 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/Frontend')
-rw-r--r-- | lib/Frontend/FrontendAction.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/Frontend/FrontendAction.cpp b/lib/Frontend/FrontendAction.cpp index 9ff7a66248..742caf158b 100644 --- a/lib/Frontend/FrontendAction.cpp +++ b/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(); |