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

Mon Apr 30 14:27:59 PDT 2018

aprantl created this revision.
aprantl added reviewers: rnk, MatzeB.
Herald added subscribers: george.burgess.iv, zzheng, gbedwell, haicheng, jakehehrlich, javed.absar, JDevlieghere, fedor.sergeev, kbarton, aheejin, eraman, jgravelle-google, sbc100, nhaehnle, nemanjai, sdardis, mehdi_amini, dschuff, arsenm, sanjoy, jfb, qcolombet, jholewinski.
Herald added a reviewer: deadalnix.
Herald added a reviewer: javed.absar.
Herald added a reviewer: andreadb.

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

  find . -name '*.cpp' -exec perl -pi -e 's/\\brief //g' \{} \;
  find . -name '*.h' -exec perl -pi -e 's/\\brief //g' \{} \;

https://reviews.llvm.org/D46290

Files:
  include/llvm-c/lto.h
  include/llvm/ADT/APFloat.h
  include/llvm/ADT/APInt.h
  include/llvm/ADT/APSInt.h
  include/llvm/ADT/ArrayRef.h
  include/llvm/ADT/BitVector.h
  include/llvm/ADT/DepthFirstIterator.h
  include/llvm/ADT/EpochTracker.h
  include/llvm/ADT/Hashing.h
  include/llvm/ADT/MapVector.h
  include/llvm/ADT/None.h
  include/llvm/ADT/PackedVector.h
  include/llvm/ADT/SCCIterator.h
  include/llvm/ADT/STLExtras.h
  include/llvm/ADT/SetVector.h
  include/llvm/ADT/SmallPtrSet.h
  include/llvm/ADT/Statistic.h
  include/llvm/ADT/StringExtras.h
  include/llvm/ADT/StringRef.h
  include/llvm/ADT/StringSwitch.h
  include/llvm/ADT/UniqueVector.h
  include/llvm/ADT/VariadicFunction.h
  include/llvm/ADT/edit_distance.h
  include/llvm/ADT/ilist.h
  include/llvm/ADT/ilist_node.h
  include/llvm/ADT/iterator.h
  include/llvm/ADT/iterator_range.h
  include/llvm/Analysis/AliasAnalysis.h
  include/llvm/Analysis/AliasAnalysisEvaluator.h
  include/llvm/Analysis/AssumptionCache.h
  include/llvm/Analysis/BasicAliasAnalysis.h
  include/llvm/Analysis/BlockFrequencyInfo.h
  include/llvm/Analysis/BlockFrequencyInfoImpl.h
  include/llvm/Analysis/BranchProbabilityInfo.h
  include/llvm/Analysis/CFG.h
  include/llvm/Analysis/CFLAndersAliasAnalysis.h
  include/llvm/Analysis/CFLSteensAliasAnalysis.h
  include/llvm/Analysis/CGSCCPassManager.h
  include/llvm/Analysis/CallGraph.h
  include/llvm/Analysis/CodeMetrics.h
  include/llvm/Analysis/ConstantFolding.h
  include/llvm/Analysis/DOTGraphTraitsPass.h
  include/llvm/Analysis/DemandedBits.h
  include/llvm/Analysis/DependenceAnalysis.h
  include/llvm/Analysis/DominanceFrontier.h
  include/llvm/Analysis/EHPersonalities.h
  include/llvm/Analysis/IndirectCallPromotionAnalysis.h
  include/llvm/Analysis/InlineCost.h
  include/llvm/Analysis/IteratedDominanceFrontier.h
  include/llvm/Analysis/LazyBlockFrequencyInfo.h
  include/llvm/Analysis/LazyBranchProbabilityInfo.h
  include/llvm/Analysis/LazyValueInfo.h
  include/llvm/Analysis/LoopAccessAnalysis.h
  include/llvm/Analysis/LoopAnalysisManager.h
  include/llvm/Analysis/LoopInfo.h
  include/llvm/Analysis/LoopUnrollAnalyzer.h
  include/llvm/Analysis/MemoryBuiltins.h
  include/llvm/Analysis/MemorySSA.h
  include/llvm/Analysis/MemorySSAUpdater.h
  include/llvm/Analysis/MustExecute.h
  include/llvm/Analysis/ObjCARCAliasAnalysis.h
  include/llvm/Analysis/ObjCARCAnalysisUtils.h
  include/llvm/Analysis/ObjCARCInstKind.h
  include/llvm/Analysis/OptimizationRemarkEmitter.h
  include/llvm/Analysis/OrderedBasicBlock.h
  include/llvm/Analysis/PostDominators.h
  include/llvm/Analysis/ProfileSummaryInfo.h
  include/llvm/Analysis/PtrUseVisitor.h
  include/llvm/Analysis/RegionInfo.h
  include/llvm/Analysis/TargetTransformInfo.h
  include/llvm/Analysis/TargetTransformInfoImpl.h
  include/llvm/Analysis/ValueTracking.h
  include/llvm/Analysis/VectorUtils.h
  include/llvm/AsmParser/Parser.h
  include/llvm/Bitcode/BitcodeWriter.h
  include/llvm/Bitcode/BitcodeWriterPass.h
  include/llvm/Bitcode/BitstreamWriter.h
  include/llvm/CodeGen/Analysis.h
  include/llvm/CodeGen/AsmPrinter.h
  include/llvm/CodeGen/AtomicExpandUtils.h
  include/llvm/CodeGen/BasicTTIImpl.h
  include/llvm/CodeGen/CalcSpillWeights.h
  include/llvm/CodeGen/CostTable.h
  include/llvm/CodeGen/DIE.h
  include/llvm/CodeGen/FastISel.h
  include/llvm/CodeGen/LazyMachineBlockFrequencyInfo.h
  include/llvm/CodeGen/LiveInterval.h
  include/llvm/CodeGen/LivePhysRegs.h
  include/llvm/CodeGen/LiveRangeEdit.h
  include/llvm/CodeGen/LiveRegUnits.h
  include/llvm/CodeGen/LoopTraversal.h
  include/llvm/CodeGen/MIRParser/MIRParser.h
  include/llvm/CodeGen/MachineBasicBlock.h
  include/llvm/CodeGen/MachineDominators.h
  include/llvm/CodeGen/MachineFunction.h
  include/llvm/CodeGen/MachineInstr.h
  include/llvm/CodeGen/MachineLoopInfo.h
  include/llvm/CodeGen/MachineOperand.h
  include/llvm/CodeGen/MachineOptimizationRemarkEmitter.h
  include/llvm/CodeGen/MachineScheduler.h
  include/llvm/CodeGen/MacroFusion.h
  include/llvm/CodeGen/PBQP/Math.h
  include/llvm/CodeGen/PBQP/ReductionRules.h
  include/llvm/CodeGen/PBQP/Solution.h
  include/llvm/CodeGen/Passes.h
  include/llvm/CodeGen/RegAllocPBQP.h
  include/llvm/CodeGen/RegisterPressure.h
  include/llvm/CodeGen/ScheduleDAG.h
  include/llvm/CodeGen/ScheduleDAGInstrs.h
  include/llvm/CodeGen/ScheduleDFS.h
  include/llvm/CodeGen/SelectionDAG.h
  include/llvm/CodeGen/SelectionDAGISel.h
  include/llvm/CodeGen/SelectionDAGNodes.h
  include/llvm/CodeGen/SlotIndexes.h
  include/llvm/CodeGen/StackMaps.h
  include/llvm/CodeGen/StackProtector.h
  include/llvm/CodeGen/TargetInstrInfo.h
  include/llvm/CodeGen/TargetLowering.h
  include/llvm/CodeGen/TargetRegisterInfo.h
  include/llvm/CodeGen/TargetSchedule.h
  include/llvm/CodeGen/TargetSubtargetInfo.h
  include/llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h
  include/llvm/DebugInfo/CodeView/TypeStreamMerger.h
  include/llvm/DebugInfo/DWARF/DWARFUnit.h
  include/llvm/DebugInfo/MSF/MSFBuilder.h
  include/llvm/DebugInfo/MSF/MSFCommon.h
  include/llvm/DebugInfo/Symbolize/Symbolize.h
  include/llvm/Demangle/Compiler.h
  include/llvm/ExecutionEngine/ExecutionEngine.h
  include/llvm/ExecutionEngine/JITSymbol.h
  include/llvm/ExecutionEngine/Orc/RPCUtils.h
  include/llvm/ExecutionEngine/RuntimeDyld.h
  include/llvm/ExecutionEngine/RuntimeDyldChecker.h
  include/llvm/ExecutionEngine/SectionMemoryManager.h
  include/llvm/IR/Attributes.h
  include/llvm/IR/CallingConv.h
  include/llvm/IR/Constants.h
  include/llvm/IR/DataLayout.h
  include/llvm/IR/DebugInfoMetadata.h
  include/llvm/IR/DebugLoc.h
  include/llvm/IR/DiagnosticHandler.h
  include/llvm/IR/DiagnosticInfo.h
  include/llvm/IR/DiagnosticPrinter.h
  include/llvm/IR/Dominators.h
  include/llvm/IR/Function.h
  include/llvm/IR/GlobalValue.h
  include/llvm/IR/IRBuilder.h
  include/llvm/IR/IRPrintingPasses.h
  include/llvm/IR/InstrTypes.h
  include/llvm/IR/LLVMContext.h
  include/llvm/IR/MDBuilder.h
  include/llvm/IR/Metadata.h
  include/llvm/IR/Module.h
  include/llvm/IR/ModuleSummaryIndex.h
  include/llvm/IR/Operator.h
  include/llvm/IR/OptBisect.h
  include/llvm/IR/PassManager.h
  include/llvm/IR/PassManagerInternal.h
  include/llvm/IR/ProfileSummary.h
  include/llvm/IR/Statepoint.h
  include/llvm/IR/TrackingMDRef.h
  include/llvm/IR/Use.h
  include/llvm/IR/UseListOrder.h
  include/llvm/IR/User.h
  include/llvm/IR/Value.h
  include/llvm/IR/ValueHandle.h
  include/llvm/IR/Verifier.h
  include/llvm/Linker/Linker.h
  include/llvm/MC/MCAsmBackend.h
  include/llvm/MC/MCAsmInfo.h
  include/llvm/MC/MCAsmLayout.h
  include/llvm/MC/MCAssembler.h
  include/llvm/MC/MCCodeView.h
  include/llvm/MC/MCContext.h
  include/llvm/MC/MCDisassembler/MCExternalSymbolizer.h
  include/llvm/MC/MCDisassembler/MCRelocationInfo.h
  include/llvm/MC/MCDisassembler/MCSymbolizer.h
  include/llvm/MC/MCDwarf.h
  include/llvm/MC/MCELFObjectWriter.h
  include/llvm/MC/MCELFStreamer.h
  include/llvm/MC/MCExpr.h
  include/llvm/MC/MCFixup.h
  include/llvm/MC/MCFixupKindInfo.h
  include/llvm/MC/MCFragment.h
  include/llvm/MC/MCInst.h
  include/llvm/MC/MCInstBuilder.h
  include/llvm/MC/MCInstPrinter.h
  include/llvm/MC/MCInstrAnalysis.h
  include/llvm/MC/MCInstrDesc.h
  include/llvm/MC/MCInstrInfo.h
  include/llvm/MC/MCInstrItineraries.h
  include/llvm/MC/MCLabel.h
  include/llvm/MC/MCObjectStreamer.h
  include/llvm/MC/MCParser/MCAsmParser.h
  include/llvm/MC/MCParser/MCAsmParserExtension.h
  include/llvm/MC/MCRegisterInfo.h
  include/llvm/MC/MCSection.h
  include/llvm/MC/MCStreamer.h
  include/llvm/MC/MCSymbol.h
  include/llvm/MC/MCSymbolMachO.h
  include/llvm/MC/MCValue.h
  include/llvm/MC/MCWasmObjectWriter.h
  include/llvm/MC/MCWasmStreamer.h
  include/llvm/MC/MCWinCOFFObjectWriter.h
  include/llvm/MC/StringTableBuilder.h
  include/llvm/Object/Archive.h
  include/llvm/Object/ELF.h
  include/llvm/Object/ELFObjectFile.h
  include/llvm/Object/IRObjectFile.h
  include/llvm/Object/MachOUniversal.h
  include/llvm/ObjectYAML/DWARFEmitter.h
  include/llvm/ObjectYAML/DWARFYAML.h
  include/llvm/ObjectYAML/ELFYAML.h
  include/llvm/ObjectYAML/MachOYAML.h
  include/llvm/ObjectYAML/WasmYAML.h
  include/llvm/ObjectYAML/YAML.h
  include/llvm/Option/Arg.h
  include/llvm/Option/ArgList.h
  include/llvm/Option/OptTable.h
  include/llvm/Option/Option.h
  include/llvm/Passes/PassBuilder.h
  include/llvm/ProfileData/Coverage/CoverageMappingReader.h
  include/llvm/ProfileData/Coverage/CoverageMappingWriter.h
  include/llvm/ProfileData/GCOV.h
  include/llvm/ProfileData/ProfileCommon.h
  include/llvm/ProfileData/SampleProf.h
  include/llvm/ProfileData/SampleProfReader.h
  include/llvm/ProfileData/SampleProfWriter.h
  include/llvm/Support/AMDGPUKernelDescriptor.h
  include/llvm/Support/AMDGPUMetadata.h
  include/llvm/Support/AlignOf.h
  include/llvm/Support/Allocator.h
  include/llvm/Support/AtomicOrdering.h
  include/llvm/Support/BinaryByteStream.h
  include/llvm/Support/BinaryStream.h
  include/llvm/Support/BinaryStreamArray.h
  include/llvm/Support/BinaryStreamReader.h
  include/llvm/Support/BinaryStreamRef.h
  include/llvm/Support/BinaryStreamWriter.h
  include/llvm/Support/BlockFrequency.h
  include/llvm/Support/BranchProbability.h
  include/llvm/Support/Casting.h
  include/llvm/Support/CommandLine.h
  include/llvm/Support/DataExtractor.h
  include/llvm/Support/DebugCounter.h
  include/llvm/Support/Endian.h
  include/llvm/Support/Error.h
  include/llvm/Support/ErrorOr.h
  include/llvm/Support/FormatVariadic.h
  include/llvm/Support/GenericDomTree.h
  (512 more files...)