[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

Matthijs Kooijman matthijs at stdin.nl
Thu May 8 14:39:46 PDT 2008


Hi Tanya,

> I'm not suggestion duplicate documentation.
> I'm just saying that if  this means that less documentation shows up in
> doxygen, then thats  bad. 
Agreed. This point could also be made for the other passes, most of which are
not doxygen'd.

> 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.
I do think the more elaborate description should show up in the passes
document. I was, howerver, under the assumption that the file header should be
identical to what shows up in the passes document, which is probably not so
true. In that case, reverting the changes to the JumpThreading.cpp file but
keeping the changes to Passes.html would probably be sufficient.

Besides this particular case, is there any reason the file headers are not
doxygen comments? And couldn't the passes document be generated using doxygen?

Gr.

Matthijs
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20080508/c5071572/attachment.sig>


More information about the llvm-commits mailing list