[Lldb-commits] [PATCH] D60508: [NFC] Remove ASCII lines from comments

Wed Apr 10 05:28:38 PDT 2019

JDevlieghere created this revision.
JDevlieghere added a reviewer: LLDB.
Herald added subscribers: jsji, abidh, arphaman, atanasyan, MaskRay, kbarton, arichardson, javed.absar, ki.stfu, nemanjai, emaste.
Herald added a reviewer: espindola.
Herald added a reviewer: jfb.
Herald added a project: LLDB.

A lot of comments in LLDB are surrounded by an ASCII line to delimit the begging and end of the comment.

  //----------------------------------------------------------------------
  /// The actual (doxygen) comment, sometimes a single line, but usually wrapped 
  /// at 80 cols. 
  //----------------------------------------------------------------------

Its use is not really consistent across the code base, sometimes the lines are longer, sometimes they are shorter and sometimes they are omitted. Furthermore, it looks kind of weird with the 80 column limit, where the comment actually extends past the line, but not by much. Furthermore, when `///` is used for Doxygen comments, it looks particularly odd. And when `//` is used, it incorrectly gives the impression that it's actually a Doxygen comment.

I assume these lines were added to improve distinguishing between comments and code. However, given that todays editors and IDEs do a great job at highlighting comments, I think it's worth to drop this for the sake of consistency. The alternative is fixing all the inconsistencies, which would create a lot more churn.

Repository:
  rLLDB LLDB

https://reviews.llvm.org/D60508

Files:
  lldb/include/lldb/API/SBAttachInfo.h
  lldb/include/lldb/API/SBBlock.h
  lldb/include/lldb/API/SBCommandInterpreter.h
  lldb/include/lldb/API/SBCompileUnit.h
  lldb/include/lldb/API/SBLaunchInfo.h
  lldb/include/lldb/API/SBMemoryRegionInfo.h
  lldb/include/lldb/API/SBModule.h
  lldb/include/lldb/API/SBModuleSpec.h
  lldb/include/lldb/API/SBPlatform.h
  lldb/include/lldb/API/SBProcess.h
  lldb/include/lldb/API/SBSection.h
  lldb/include/lldb/API/SBStructuredData.h
  lldb/include/lldb/API/SBSymbol.h
  lldb/include/lldb/API/SBTarget.h
  lldb/include/lldb/API/SBThread.h
  lldb/include/lldb/API/SBThreadPlan.h
  lldb/include/lldb/API/SBTrace.h
  lldb/include/lldb/API/SBValue.h
  lldb/include/lldb/Breakpoint/Breakpoint.h
  lldb/include/lldb/Breakpoint/BreakpointID.h
  lldb/include/lldb/Breakpoint/BreakpointIDList.h
  lldb/include/lldb/Breakpoint/BreakpointList.h
  lldb/include/lldb/Breakpoint/BreakpointLocation.h
  lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h
  lldb/include/lldb/Breakpoint/BreakpointLocationList.h
  lldb/include/lldb/Breakpoint/BreakpointOptions.h
  lldb/include/lldb/Breakpoint/BreakpointResolver.h
  lldb/include/lldb/Breakpoint/BreakpointResolverAddress.h
  lldb/include/lldb/Breakpoint/BreakpointResolverFileLine.h
  lldb/include/lldb/Breakpoint/BreakpointResolverFileRegex.h
  lldb/include/lldb/Breakpoint/BreakpointResolverName.h
  lldb/include/lldb/Breakpoint/BreakpointResolverScripted.h
  lldb/include/lldb/Breakpoint/BreakpointSite.h
  lldb/include/lldb/Breakpoint/BreakpointSiteList.h
  lldb/include/lldb/Breakpoint/Stoppoint.h
  lldb/include/lldb/Breakpoint/StoppointCallbackContext.h
  lldb/include/lldb/Breakpoint/StoppointLocation.h
  lldb/include/lldb/Breakpoint/Watchpoint.h
  lldb/include/lldb/Breakpoint/WatchpointList.h
  lldb/include/lldb/Breakpoint/WatchpointOptions.h
  lldb/include/lldb/Core/Address.h
  lldb/include/lldb/Core/AddressRange.h
  lldb/include/lldb/Core/AddressResolver.h
  lldb/include/lldb/Core/AddressResolverFileLine.h
  lldb/include/lldb/Core/AddressResolverName.h
  lldb/include/lldb/Core/Architecture.h
  lldb/include/lldb/Core/Communication.h
  lldb/include/lldb/Core/Debugger.h
  lldb/include/lldb/Core/Disassembler.h
  lldb/include/lldb/Core/DumpDataExtractor.h
  lldb/include/lldb/Core/EmulateInstruction.h
  lldb/include/lldb/Core/FileLineResolver.h
  lldb/include/lldb/Core/FileSpecList.h
  lldb/include/lldb/Core/FormatEntity.h
  lldb/include/lldb/Core/Highlighter.h
  lldb/include/lldb/Core/IOHandler.h
  lldb/include/lldb/Core/Mangled.h
  lldb/include/lldb/Core/Module.h
  lldb/include/lldb/Core/ModuleChild.h
  lldb/include/lldb/Core/ModuleList.h
  lldb/include/lldb/Core/PluginManager.h
  lldb/include/lldb/Core/STLUtils.h
  lldb/include/lldb/Core/SearchFilter.h
  lldb/include/lldb/Core/Section.h
  lldb/include/lldb/Core/SourceManager.h
  lldb/include/lldb/Core/StreamFile.h
  lldb/include/lldb/Core/ThreadSafeSTLMap.h
  lldb/include/lldb/Core/ThreadSafeSTLVector.h
  lldb/include/lldb/Core/ThreadSafeValue.h
  lldb/include/lldb/Core/UniqueCStringMap.h
  lldb/include/lldb/Core/ValueObject.h
  lldb/include/lldb/Core/ValueObjectCast.h
  lldb/include/lldb/Core/ValueObjectChild.h
  lldb/include/lldb/Core/ValueObjectConstResult.h
  lldb/include/lldb/Core/ValueObjectConstResultChild.h
  lldb/include/lldb/Core/ValueObjectConstResultImpl.h
  lldb/include/lldb/Core/ValueObjectDynamicValue.h
  lldb/include/lldb/Core/ValueObjectList.h
  lldb/include/lldb/Core/ValueObjectMemory.h
  lldb/include/lldb/Core/ValueObjectRegister.h
  lldb/include/lldb/Core/ValueObjectSyntheticFilter.h
  lldb/include/lldb/Core/ValueObjectVariable.h
  lldb/include/lldb/Expression/DWARFExpression.h
  lldb/include/lldb/Expression/Expression.h
  lldb/include/lldb/Expression/ExpressionParser.h
  lldb/include/lldb/Expression/ExpressionTypeSystemHelper.h
  lldb/include/lldb/Expression/ExpressionVariable.h
  lldb/include/lldb/Expression/FunctionCaller.h
  lldb/include/lldb/Expression/IRDynamicChecks.h
  lldb/include/lldb/Expression/IRExecutionUnit.h
  lldb/include/lldb/Expression/IRInterpreter.h
  lldb/include/lldb/Expression/IRMemoryMap.h
  lldb/include/lldb/Expression/LLVMUserExpression.h
  lldb/include/lldb/Expression/REPL.h
  lldb/include/lldb/Expression/UserExpression.h
  lldb/include/lldb/Expression/UtilityFunction.h
  lldb/include/lldb/Host/Debug.h
  lldb/include/lldb/Host/File.h
  lldb/include/lldb/Host/Host.h
  lldb/include/lldb/Host/HostInfo.h
  lldb/include/lldb/Host/HostInfoBase.h
  lldb/include/lldb/Host/HostProcess.h
  lldb/include/lldb/Host/HostThread.h
  lldb/include/lldb/Host/ProcessLaunchInfo.h
  lldb/include/lldb/Host/ProcessRunLock.h
  lldb/include/lldb/Host/PseudoTerminal.h
  lldb/include/lldb/Host/SocketAddress.h
  lldb/include/lldb/Host/StringConvert.h
  lldb/include/lldb/Host/Terminal.h
  lldb/include/lldb/Host/XML.h
  lldb/include/lldb/Host/common/NativeProcessProtocol.h
  lldb/include/lldb/Host/common/NativeRegisterContext.h
  lldb/include/lldb/Host/common/NativeThreadProtocol.h
  lldb/include/lldb/Host/posix/PipePosix.h
  lldb/include/lldb/Host/windows/PipeWindows.h
  lldb/include/lldb/Initialization/SystemInitializerCommon.h
  lldb/include/lldb/Interpreter/CommandCompletions.h
  lldb/include/lldb/Interpreter/CommandInterpreter.h
  lldb/include/lldb/Interpreter/CommandObject.h
  lldb/include/lldb/Interpreter/CommandObjectMultiword.h
  lldb/include/lldb/Interpreter/CommandObjectRegexCommand.h
  lldb/include/lldb/Interpreter/OptionGroupArchitecture.h
  lldb/include/lldb/Interpreter/OptionGroupBoolean.h
  lldb/include/lldb/Interpreter/OptionGroupFile.h
  lldb/include/lldb/Interpreter/OptionGroupFormat.h
  lldb/include/lldb/Interpreter/OptionGroupOutputFile.h
  lldb/include/lldb/Interpreter/OptionGroupPlatform.h
  lldb/include/lldb/Interpreter/OptionGroupString.h
  lldb/include/lldb/Interpreter/OptionGroupUInt64.h
  lldb/include/lldb/Interpreter/OptionGroupUUID.h
  lldb/include/lldb/Interpreter/OptionGroupValueObjectDisplay.h
  lldb/include/lldb/Interpreter/OptionGroupVariable.h
  lldb/include/lldb/Interpreter/OptionGroupWatchpoint.h
  lldb/include/lldb/Interpreter/OptionValue.h
  lldb/include/lldb/Interpreter/OptionValueArch.h
  lldb/include/lldb/Interpreter/OptionValueArray.h
  lldb/include/lldb/Interpreter/OptionValueBoolean.h
  lldb/include/lldb/Interpreter/OptionValueChar.h
  lldb/include/lldb/Interpreter/OptionValueDictionary.h
  lldb/include/lldb/Interpreter/OptionValueEnumeration.h
  lldb/include/lldb/Interpreter/OptionValueFileSpec.h
  lldb/include/lldb/Interpreter/OptionValueFileSpecList.h
  lldb/include/lldb/Interpreter/OptionValueFormat.h
  lldb/include/lldb/Interpreter/OptionValueFormatEntity.h
  lldb/include/lldb/Interpreter/OptionValueLanguage.h
  lldb/include/lldb/Interpreter/OptionValuePathMappings.h
  lldb/include/lldb/Interpreter/OptionValueProperties.h
  lldb/include/lldb/Interpreter/OptionValueRegex.h
  lldb/include/lldb/Interpreter/OptionValueSInt64.h
  lldb/include/lldb/Interpreter/OptionValueString.h
  lldb/include/lldb/Interpreter/OptionValueUInt64.h
  lldb/include/lldb/Interpreter/OptionValueUUID.h
  lldb/include/lldb/Interpreter/Options.h
  lldb/include/lldb/Symbol/Block.h
  lldb/include/lldb/Symbol/ClangASTContext.h
  lldb/include/lldb/Symbol/ClangExternalASTSourceCallbacks.h
  lldb/include/lldb/Symbol/CompileUnit.h
  lldb/include/lldb/Symbol/CompilerDecl.h
  lldb/include/lldb/Symbol/CompilerDeclContext.h
  lldb/include/lldb/Symbol/CompilerType.h
  lldb/include/lldb/Symbol/DWARFCallFrameInfo.h
  lldb/include/lldb/Symbol/DeclVendor.h
  lldb/include/lldb/Symbol/Declaration.h
  lldb/include/lldb/Symbol/Function.h
  lldb/include/lldb/Symbol/LineEntry.h
  lldb/include/lldb/Symbol/LineTable.h
  lldb/include/lldb/Symbol/LocateSymbolFile.h
  lldb/include/lldb/Symbol/ObjectContainer.h
  lldb/include/lldb/Symbol/ObjectFile.h
  lldb/include/lldb/Symbol/Symbol.h
  lldb/include/lldb/Symbol/SymbolContext.h
  lldb/include/lldb/Symbol/SymbolContextScope.h
  lldb/include/lldb/Symbol/SymbolFile.h
  lldb/include/lldb/Symbol/SymbolVendor.h
  lldb/include/lldb/Symbol/Symtab.h
  lldb/include/lldb/Symbol/Type.h
  lldb/include/lldb/Symbol/TypeList.h
  lldb/include/lldb/Symbol/TypeMap.h
  lldb/include/lldb/Symbol/TypeSystem.h
  lldb/include/lldb/Symbol/Variable.h
  lldb/include/lldb/Symbol/VariableList.h
  lldb/include/lldb/Target/ABI.h
  lldb/include/lldb/Target/CPPLanguageRuntime.h
  lldb/include/lldb/Target/DynamicLoader.h
  lldb/include/lldb/Target/ExecutionContext.h
  lldb/include/lldb/Target/ExecutionContextScope.h
  lldb/include/lldb/Target/JITLoader.h
  lldb/include/lldb/Target/JITLoaderList.h
  lldb/include/lldb/Target/Language.h
  lldb/include/lldb/Target/LanguageRuntime.h
  lldb/include/lldb/Target/Memory.h
  lldb/include/lldb/Target/MemoryRegionInfo.h
  lldb/include/lldb/Target/ModuleCache.h
  lldb/include/lldb/Target/ObjCLanguageRuntime.h
  lldb/include/lldb/Target/OperatingSystem.h
  lldb/include/lldb/Target/PathMappingList.h
  lldb/include/lldb/Target/Platform.h
  lldb/include/lldb/Target/Process.h
  lldb/include/lldb/Target/Queue.h
  lldb/include/lldb/Target/QueueItem.h
  lldb/include/lldb/Target/QueueList.h
  lldb/include/lldb/Target/RegisterContext.h
  lldb/include/lldb/Target/RegisterNumber.h
  lldb/include/lldb/Target/SectionLoadHistory.h
  lldb/include/lldb/Target/SectionLoadList.h
  lldb/include/lldb/Target/StackFrame.h
  lldb/include/lldb/Target/StackFrameList.h
  lldb/include/lldb/Target/StackID.h
  lldb/include/lldb/Target/StopInfo.h
  lldb/include/lldb/Target/SystemRuntime.h
  lldb/include/lldb/Target/Target.h
  lldb/include/lldb/Target/TargetList.h
  lldb/include/lldb/Target/Thread.h
  lldb/include/lldb/Target/ThreadList.h
  lldb/include/lldb/Target/ThreadPlan.h
  lldb/include/lldb/Target/ThreadPlanBase.h
  lldb/include/lldb/Target/ThreadPlanPython.h
  lldb/include/lldb/Target/ThreadPlanShouldStopHere.h
  lldb/include/lldb/Target/UnixSignals.h
  lldb/include/lldb/Target/Unwind.h
  lldb/include/lldb/Utility/ArchSpec.h
  lldb/include/lldb/Utility/Args.h
  lldb/include/lldb/Utility/Baton.h
  lldb/include/lldb/Utility/Broadcaster.h
  lldb/include/lldb/Utility/CompletionRequest.h
  lldb/include/lldb/Utility/Connection.h
  lldb/include/lldb/Utility/ConstString.h
  lldb/include/lldb/Utility/DataBuffer.h
  lldb/include/lldb/Utility/DataBufferHeap.h
  lldb/include/lldb/Utility/DataEncoder.h
  lldb/include/lldb/Utility/DataExtractor.h
  lldb/include/lldb/Utility/Event.h
  lldb/include/lldb/Utility/FileSpec.h
  lldb/include/lldb/Utility/Flags.h
  lldb/include/lldb/Utility/Listener.h
  lldb/include/lldb/Utility/Log.h
  lldb/include/lldb/Utility/Logging.h
  lldb/include/lldb/Utility/Predicate.h
  lldb/include/lldb/Utility/ProcessInfo.h
  lldb/include/lldb/Utility/RangeMap.h
  lldb/include/lldb/Utility/RegularExpression.h
  lldb/include/lldb/Utility/Scalar.h
  lldb/include/lldb/Utility/State.h
  lldb/include/lldb/Utility/Status.h
  lldb/include/lldb/Utility/Stream.h
  lldb/include/lldb/Utility/StreamGDBRemote.h
  lldb/include/lldb/Utility/StringExtractor.h
  lldb/include/lldb/Utility/StructuredData.h
  lldb/include/lldb/Utility/Timer.h
  lldb/include/lldb/Utility/UUID.h
  (473 more files...)