[llvm-dev] Doxygen for TableGen files

[Madhur Amilkanthwar via llvm-dev]

I second David's statements.

IMHO, sophisticated tools like Doxygen provides just a platform to document
but as developers we have to *document*. We should follow a strict practice
of documentation for each part of the code we write. Until this happens, no
tool will ever help (unless its AI based which can automagically generate
comments!)
If we follow such practice even code comments would be useful.

On Mon, Aug 24, 2020, 10:28 PM David Greene via llvm-dev <
llvm-dev at lists.llvm.org> wrote:

> Nicolai Hähnle via llvm-dev <llvm-dev at lists.llvm.org> writes:
>
> > Though perhaps a first question to ask is to what extent people use
> > Doxygen on the C++ part of LLVM today :)
>
> I personally only use it on very rare occasion, mostly because it's kind
> of unwieldy (difficult to navigate, search, etc.).  I have hopes that
> maybe clang-doc will get to a better place but of course that wouldn't
> work on .td files.
>
> I'm much more likely to just look through comments in code because I'm
> already in my editor and it's easy to pull up a file I need.  Before
> working on a new documentation tool for .td files I'd prefer we just
> comment them better.
>
>                     -David
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
> https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20200824/335f9dd9/attachment.html>