[LLVMdev] Comments: file header or class

[Reid Spencer]

Hi Vladimir,

This is a known problem. There are many useful comments even in headers
like Type.h and Module.h that do not come through to the doxygen
documentation. The reason is that they are using // instead of /// for
the comment or some other syntax that doxygen ignores. The job of
converting all the header files is quite a big one. Its something I've
been meaning to do, but no one has requested it until now. 

If you're familiar with doxygen, please feel free to send patches for
this. If you'd like to "learn by example", please see the headers in
lib/System which were written from the start to be doxygen friendly.

I'll do what I can with MachineConstantPool.h.

Reid.

On Mon, 2006-05-15 at 13:45 +0400, Vladimir Prus wrote:
> Hi,
> right now many classes have comments that don't show up in Doxygen. Say,
> MachineConstantPool.h has a big file-level comment, but it does not show up
> when looking at the generated docs for MachineConstantPool.
> 
> Are patches moving file comments to appear before relevant classes welcome?
> 
> - Volodya
> 
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20060515/bbc7b088/attachment.sig>