[PATCH] D74890: [Analysis] getParentLoop() documentation

[Florian Hahn via Phabricator via llvm-commits]

fhahn added inline comments.


================
Comment at: llvm/include/llvm/Analysis/LoopInfo.h:106
   BlockT *getHeader() const { return getBlocks().front(); }
+  // Return the parent loop of this loop (i.e. the loop in which
+  // this loop is entirely contained). If there's no such loop (i.e.
----------------
baziotis wrote:
> fhahn wrote:
> > fhahn wrote:
> > > Use `///`. That's how doxygen comments are defined. It might also be worth clarifying the parent loop relationship in https://llvm.org/docs/LoopTerminology.html.
> > > 
> > > For the comment here I would suggest to start with a brief first sentence and maybe another one that explain the parent relationship, like
> > > 
> > > Return the parent loop if it exists or nullptr otherwise.
> > > Use ///. That's how doxygen comments are defined. It might also be worth clarifying the parent loop relationship in https://llvm.org/docs/LoopTerminology.html.
> > 
> > Reading this back I realized it might sound a bit harsh. That was not the intention, sorry!
> No problem, thanks for the review! To change the `LoopTerminology.html` I change the `/llvm/docs/LoopTerminology.rst` right?
Yep, that would be great!


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D74890/new/

https://reviews.llvm.org/D74890