[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

[Tanya 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)?
>

I'm not suggestion duplicate documentation. I'm just saying that if  
this means that less documentation shows up in doxygen, then thats  
bad. I would much prefer that the file description be simple/generic  
and the comments for function/class be more detailed so it shows up  
in doxygen.

This is just my personal opinion, so others can weigh in.

-Tanya

> Gr.
>
> Matthijs
> _______________________________________________
> llvm-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits