[llvm-commits] [llvm] r50861 - in /llvm/trunk: docs/Passes.html lib/Transforms/IPO/StripDeadPrototypes.cpp lib/Transforms/IPO/StructRetPromotion.cpp lib/Transforms/Scalar/CodeGenPrepare.cpp lib/Transforms/Scalar/JumpThreading.cpp lib/Transforms/Scalar/LoopDeletion.cpp

[Chris Lattner]

On May 8, 2008, at 11:48 AM, Matthijs Kooijman wrote:

> Hi,
>
>> For the changes to the JumpThreading Class, I don't think doxygen
>> will pick up the comments at the top of the file (but correct me if I
>> am wrong).
> From what I've seen, none of the other passes have duplicate  
> documentation
> like this? I agree that having comments in the API docs is quite  
> desirable,
> but wouldn't it be better to make the per-file comments doxygen  
> style as well
> then (and perhaps add a reference)?

The substantial documentation should go in a doxygen comment above the  
class, with only a small comment in the file header.  The  
JumpThreading pass was the preferred way to do this.  Other passes  
that aren't following that style should be updated.

-Chris