[Lldb-commits] [PATCH] D46144: Reflow paragraphs in comments.

[Pavel Labath via Phabricator via lldb-commits]

labath added a comment.

The formatting of the comments has been bugging me as well. So far, I have been trying to reflow them whenever I touch the code around them, but at that rate fixing all of them would take ages.

Your heuristics seem to be working fairly well. I've found a couple of sub-optimal decisions in the few files I opened, but I am not sure if it's feasible to fix the algorithm to account for them.

So overall, this seems like a good idea to me, and the few places where it gets this wrong can be fixed up afterwards (it decreases the total number of badly formatted comments).

PS: I don't see any header files in the list. Is there a particular reason for skipping them?



================
Comment at: source/API/SBDebugger.cpp:73
+    // This calls the bool lldb::PluginInitialize(lldb::SBDebugger
+    // debugger) function. TODO: mangle this differently for your system -
+    // on OSX, the first underscore needs to be removed and the second one
----------------
Folding TODO: Here is sub-optimal.


================
Comment at: source/API/SBInstruction.cpp:37-38
 // 1  lldb::SBInstruction inst;
-// 2  inst = target.ReadInstructions(pc, 1).GetInstructionAtIndex(0)
-// 3  if (inst.DoesBranch())
-// 4  ...
+// 2  inst = target.ReadInstructions(pc, 1).GetInstructionAtIndex(0) 3  if
+// (inst.DoesBranch()) 4  ...
 //
----------------
This doesn't look right.


https://reviews.llvm.org/D46144