[PATCH] D46320: Remove \brief commands from doxygen comments.

Adrian Prantl via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue May 1 09:21:52 PDT 2018


aprantl created this revision.
aprantl added a reviewer: rsmith.
Herald added subscribers: kbarton, aheejin, eraman, jgravelle-google, sbc100, nhaehnle, nemanjai, dschuff, jfb, jholewinski, klimek.

Note that I did the same thing for LLVM this morning (https://reviews.llvm.org/D46290).

We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all.

Patch produced by

`for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done`
`for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done`


https://reviews.llvm.org/D46320

Files:
  docs/LibFormat.rst
  include/clang-c/BuildSystem.h
  include/clang-c/CXCompilationDatabase.h
  include/clang-c/CXErrorCode.h
  include/clang-c/CXString.h
  include/clang-c/Documentation.h
  include/clang-c/Index.h
  include/clang/ARCMigrate/ARCMT.h
  include/clang/ARCMigrate/ARCMTActions.h
  include/clang/AST/APValue.h
  include/clang/AST/ASTConsumer.h
  include/clang/AST/ASTContext.h
  include/clang/AST/ASTDiagnostic.h
  include/clang/AST/ASTFwd.h
  include/clang/AST/ASTImporter.h
  include/clang/AST/ASTLambda.h
  include/clang/AST/ASTMutationListener.h
  include/clang/AST/ASTTypeTraits.h
  include/clang/AST/ASTUnresolvedSet.h
  include/clang/AST/Attr.h
  include/clang/AST/Availability.h
  include/clang/AST/CXXInheritance.h
  include/clang/AST/CanonicalType.h
  include/clang/AST/CommentBriefParser.h
  include/clang/AST/CommentCommandTraits.h
  include/clang/AST/CommentLexer.h
  include/clang/AST/CommentSema.h
  include/clang/AST/DataCollection.h
  include/clang/AST/Decl.h
  include/clang/AST/DeclBase.h
  include/clang/AST/DeclCXX.h
  include/clang/AST/DeclContextInternals.h
  include/clang/AST/DeclObjC.h
  include/clang/AST/DeclOpenMP.h
  include/clang/AST/DeclTemplate.h
  include/clang/AST/DeclVisitor.h
  include/clang/AST/DeclarationName.h
  include/clang/AST/EvaluatedExprVisitor.h
  include/clang/AST/Expr.h
  include/clang/AST/ExprCXX.h
  include/clang/AST/ExprObjC.h
  include/clang/AST/ExprOpenMP.h
  include/clang/AST/ExternalASTSource.h
  include/clang/AST/LambdaCapture.h
  include/clang/AST/LocInfoType.h
  include/clang/AST/Mangle.h
  include/clang/AST/MangleNumberingContext.h
  include/clang/AST/NSAPI.h
  include/clang/AST/NestedNameSpecifier.h
  include/clang/AST/OpenMPClause.h
  include/clang/AST/OperationKinds.def
  include/clang/AST/OperationKinds.h
  include/clang/AST/ParentMap.h
  include/clang/AST/PrettyPrinter.h
  include/clang/AST/QualTypeNames.h
  include/clang/AST/RawCommentList.h
  include/clang/AST/RecordLayout.h
  include/clang/AST/RecursiveASTVisitor.h
  include/clang/AST/Redeclarable.h
  include/clang/AST/SelectorLocationsKind.h
  include/clang/AST/Stmt.h
  include/clang/AST/StmtCXX.h
  include/clang/AST/StmtObjC.h
  include/clang/AST/StmtOpenMP.h
  include/clang/AST/StmtVisitor.h
  include/clang/AST/TemplateBase.h
  include/clang/AST/TemplateName.h
  include/clang/AST/Type.h
  include/clang/AST/TypeLoc.h
  include/clang/AST/TypeOrdering.h
  include/clang/AST/TypeVisitor.h
  include/clang/AST/UnresolvedSet.h
  include/clang/AST/VTTBuilder.h
  include/clang/AST/VTableBuilder.h
  include/clang/ASTMatchers/ASTMatchFinder.h
  include/clang/ASTMatchers/ASTMatchers.h
  include/clang/ASTMatchers/ASTMatchersInternal.h
  include/clang/ASTMatchers/ASTMatchersMacros.h
  include/clang/ASTMatchers/Dynamic/Diagnostics.h
  include/clang/ASTMatchers/Dynamic/Parser.h
  include/clang/ASTMatchers/Dynamic/Registry.h
  include/clang/ASTMatchers/Dynamic/VariantValue.h
  include/clang/Analysis/Analyses/Consumed.h
  include/clang/Analysis/Analyses/Dominators.h
  include/clang/Analysis/Analyses/FormatString.h
  include/clang/Analysis/Analyses/PostOrderCFGView.h
  include/clang/Analysis/Analyses/ThreadSafety.h
  include/clang/Analysis/Analyses/ThreadSafetyCommon.h
  include/clang/Analysis/Analyses/ThreadSafetyLogical.h
  include/clang/Analysis/AnalysisDeclContext.h
  include/clang/Analysis/CFG.h
  include/clang/Analysis/CallGraph.h
  include/clang/Analysis/CodeInjector.h
  include/clang/Analysis/ProgramPoint.h
  include/clang/Basic/ABI.h
  include/clang/Basic/AddressSpaces.h
  include/clang/Basic/AlignedAllocation.h
  include/clang/Basic/AllDiagnostics.h
  include/clang/Basic/AttrKinds.h
  include/clang/Basic/AttrSubjectMatchRules.h
  include/clang/Basic/Attributes.h
  include/clang/Basic/Builtins.h
  include/clang/Basic/BuiltinsWebAssembly.def
  include/clang/Basic/CapturedStmt.h
  include/clang/Basic/CommentOptions.h
  include/clang/Basic/Diagnostic.h
  include/clang/Basic/DiagnosticError.h
  include/clang/Basic/DiagnosticIDs.h
  include/clang/Basic/DiagnosticOptions.h
  include/clang/Basic/ExceptionSpecificationType.h
  include/clang/Basic/ExpressionTraits.h
  include/clang/Basic/FileManager.h
  include/clang/Basic/FileSystemOptions.h
  include/clang/Basic/FileSystemStatCache.h
  include/clang/Basic/IdentifierTable.h
  include/clang/Basic/LLVM.h
  include/clang/Basic/Lambda.h
  include/clang/Basic/LangOptions.def
  include/clang/Basic/LangOptions.h
  include/clang/Basic/Linkage.h
  include/clang/Basic/MacroBuilder.h
  include/clang/Basic/Module.h
  include/clang/Basic/ObjCRuntime.h
  include/clang/Basic/OpenCLOptions.h
  include/clang/Basic/OpenMPKinds.def
  include/clang/Basic/OpenMPKinds.h
  include/clang/Basic/OperatorKinds.h
  include/clang/Basic/OperatorPrecedence.h
  include/clang/Basic/PartialDiagnostic.h
  include/clang/Basic/PrettyStackTrace.h
  include/clang/Basic/Sanitizers.h
  include/clang/Basic/SourceLocation.h
  include/clang/Basic/SourceManager.h
  include/clang/Basic/SourceManagerInternals.h
  include/clang/Basic/Specifiers.h
  include/clang/Basic/SyncScope.h
  include/clang/Basic/TargetBuiltins.h
  include/clang/Basic/TargetCXXABI.h
  include/clang/Basic/TargetInfo.h
  include/clang/Basic/TargetOptions.h
  include/clang/Basic/TemplateKinds.h
  include/clang/Basic/TokenKinds.h
  include/clang/Basic/TypeTraits.h
  include/clang/Basic/Version.h
  include/clang/Basic/VersionTuple.h
  include/clang/Basic/VirtualFileSystem.h
  include/clang/Basic/Visibility.h
  include/clang/Basic/XRayInstr.h
  include/clang/CodeGen/CGFunctionInfo.h
  include/clang/CrossTU/CrossTranslationUnit.h
  include/clang/Driver/Action.h
  include/clang/Driver/Driver.h
  include/clang/Driver/Job.h
  include/clang/Driver/Multilib.h
  include/clang/Driver/Tool.h
  include/clang/Driver/ToolChain.h
  include/clang/Edit/EditsReceiver.h
  include/clang/Format/Format.h
  include/clang/Frontend/ASTUnit.h
  include/clang/Frontend/ChainedDiagnosticConsumer.h
  include/clang/Frontend/CodeGenOptions.def
  include/clang/Frontend/CodeGenOptions.h
  include/clang/Frontend/CommandLineSourceLoc.h
  include/clang/Frontend/CompilerInstance.h
  include/clang/Frontend/CompilerInvocation.h
  include/clang/Frontend/DependencyOutputOptions.h
  include/clang/Frontend/DiagnosticRenderer.h
  include/clang/Frontend/FrontendAction.h
  include/clang/Frontend/FrontendActions.h
  include/clang/Frontend/FrontendOptions.h
  include/clang/Frontend/LayoutOverrideSource.h
  include/clang/Frontend/PrecompiledPreamble.h
  include/clang/Frontend/SerializedDiagnosticPrinter.h
  include/clang/Frontend/SerializedDiagnosticReader.h
  include/clang/Frontend/SerializedDiagnostics.h
  include/clang/Frontend/TextDiagnostic.h
  include/clang/Frontend/TextDiagnosticPrinter.h
  include/clang/Frontend/VerifyDiagnosticConsumer.h
  include/clang/Index/USRGeneration.h
  include/clang/Lex/CodeCompletionHandler.h
  include/clang/Lex/DirectoryLookup.h
  include/clang/Lex/ExternalPreprocessorSource.h
  include/clang/Lex/HeaderSearch.h
  include/clang/Lex/HeaderSearchOptions.h
  include/clang/Lex/Lexer.h
  include/clang/Lex/LiteralSupport.h
  include/clang/Lex/MacroInfo.h
  include/clang/Lex/ModuleLoader.h
  include/clang/Lex/ModuleMap.h
  include/clang/Lex/MultipleIncludeOpt.h
  include/clang/Lex/PPCallbacks.h
  include/clang/Lex/PPConditionalDirectiveRecord.h
  include/clang/Lex/Pragma.h
  include/clang/Lex/PreprocessingRecord.h
  include/clang/Lex/Preprocessor.h
  include/clang/Lex/PreprocessorLexer.h
  include/clang/Lex/PreprocessorOptions.h
  include/clang/Lex/Token.h
  include/clang/Lex/TokenLexer.h
  include/clang/Lex/VariadicMacroSupport.h
  include/clang/Parse/ParseAST.h
  include/clang/Parse/Parser.h
  include/clang/Parse/RAIIObjectsForParser.h
  include/clang/Rewrite/Core/RewriteBuffer.h
  include/clang/Rewrite/Core/Rewriter.h
  include/clang/Rewrite/Frontend/FixItRewriter.h
  include/clang/Rewrite/Frontend/FrontendActions.h
  include/clang/Sema/AnalysisBasedWarnings.h
  include/clang/Sema/AttributeList.h
  include/clang/Sema/CodeCompleteConsumer.h
  include/clang/Sema/DeclSpec.h
  include/clang/Sema/DelayedDiagnostic.h
  include/clang/Sema/ExternalSemaSource.h
  include/clang/Sema/IdentifierResolver.h
  include/clang/Sema/Initialization.h
  include/clang/Sema/Lookup.h
  include/clang/Sema/LoopHint.h
  include/clang/Sema/MultiplexExternalSemaSource.h
  include/clang/Sema/ObjCMethodList.h
  include/clang/Sema/Overload.h
  include/clang/Sema/Ownership.h
  include/clang/Sema/ParsedTemplate.h
  include/clang/Sema/Scope.h
  include/clang/Sema/ScopeInfo.h
  include/clang/Sema/Sema.h
  include/clang/Sema/SemaConsumer.h
  include/clang/Sema/SemaInternal.h
  include/clang/Sema/SemaLambda.h
  include/clang/Sema/Template.h
  include/clang/Sema/TemplateDeduction.h
  include/clang/Sema/TemplateInstCallback.h
  include/clang/Sema/TypoCorrection.h
  include/clang/Sema/Weak.h
  include/clang/Serialization/ASTBitCodes.h
  include/clang/Serialization/ASTDeserializationListener.h
  include/clang/Serialization/ASTReader.h
  include/clang/Serialization/ASTWriter.h
  include/clang/Serialization/ContinuousRangeMap.h
  include/clang/Serialization/GlobalModuleIndex.h
  include/clang/Serialization/Module.h
  include/clang/Serialization/ModuleManager.h
  include/clang/StaticAnalyzer/Core/AnalyzerOptions.h
  include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h
  include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h
  include/clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h
  include/clang/StaticAnalyzer/Core/Checker.h
  include/clang/StaticAnalyzer/Core/CheckerManager.h
  include/clang/StaticAnalyzer/Core/IssueHash.h
  include/clang/StaticAnalyzer/Core/PathSensitive/APSIntType.h
  include/clang/StaticAnalyzer/Core/PathSensitive/BlockCounter.h
  (383 more files...)





More information about the cfe-commits mailing list