[LLVMdev] doxygen redux

John Mosby ojomojo at gmail.com
Thu May 6 09:51:51 PDT 2010


Excellent work, this greatly improves the clarity of the generated docs.

I would love it if the inheritance diagrams were kept as they are and
the collaboration diagrams were hidden under a knob.

Thanks,
John

On Fri, Apr 30, 2010 at 8:54 AM, mike-m <mikem.llvm at gmail.com> wrote:

> Hi, I'm working on a patch to overhaul docs+doxygen builds for both llvm
> and clang source trees.
>
> Here's a sample of what it looks like for class clang::driver::Action
> (sorry, llvm API docs are a bigger set so only clang has been posted at this
> free webhost). Basically the output is a bump to latest doxygen plus custom
> css; the wins (IMHO) are the new style doesn't waste so much vertical page
> space, and uses slightly smaller fonts for both diagrams and html.
>
> NEW: http://kona.zzl.org/clang/api/classclang_1_1driver_1_1Action.html
> OLD: http://clang.llvm.org/doxygen/classclang_1_1driver_1_1Action.html
>
> class with more inheritance:
> http://kona.zzl.org/clang/api/classclang_1_1Decl.html
> class with a rather large collaboration diagram:
> http://kona.zzl.org/clang/api/classclang_1_1ASTContext.html
>
> I'm not sure how the project/community feels about collab-diagrams. I find
> them exceedingly large and rarely useful. There are a couple of options if
> changes in that area are desired: (1) disable collab-diagrams. (2) make both
> class-inheritance and collab-diagrams hidden under a javascript-knob which
> users can click to expand each diagram.
>
> Comments and suggestions are solicited!
>
> (patches for this are being tracked with pr6613).
>
> --mike-m
>
>
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20100506/9cb80190/attachment.html>


More information about the llvm-dev mailing list