[cfe-dev] How to link to "more docs" for clang-tidy checks

[Manuel Klimek via cfe-dev]

On Thu, Oct 8, 2015 at 11:22 PM Richard via cfe-dev <cfe-dev at lists.llvm.org>
wrote:

>
> [Please reply *only* to the list and do not include my email directly
> in the To: or Cc: of your reply.  Thanks.]
>
> In article <
> CAK_tg0xg7mYqndkS9W1p9g8+AEDphMRwM+ni_s69NyqcSvWGFw at mail.gmail.com>,
>     Daniel Jasper via cfe-dev <cfe-dev at lists.llvm.org> writes:
>
> > I think we should first solve the internal documentation problem, i.e.
> > consider how we link to 3rd party documents later. For me, the important
> > question is where the documentation should actually live. I would prefer
> it
> > to live in the source files itself.
>
> Me too.
>

Note that I started this thread specifically to talk about documentation
that we don't want to maintain as part of our own source code, because it
is much too large for that (look at examples of the C++ core guidelines;
every check has a large text with lots of examples why it is enforced).

I don't think we want to maintain a copy of the C++ core guidelines in our
source code.


>
> When the recent commit was made that added the documentation for the
> checks to the source tree, Alex and I discussed that it would be
> better to have it extracted from source.
>
> That way, you update the check and fix the comment in the source and
> this ends up in the generated doxygen and the generated user
> documentation all from a single source of truth.
> --
> "The Direct3D Graphics Pipeline" free book <
> http://tinyurl.com/d3d-pipeline>
>      The Computer Graphics Museum <http://ComputerGraphicsMuseum.org>
>          The Terminals Wiki <http://terminals.classiccmp.org>
>   Legalize Adulthood! (my blog) <http://LegalizeAdulthood.wordpress.com>
> _______________________________________________
> cfe-dev mailing list
> cfe-dev at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20151009/6a02dc59/attachment.html>