[PATCH] D22717: Improve documentation of the type safety attributes

Yunzhong Gao via cfe-commits cfe-commits at lists.llvm.org
Fri Jul 22 18:30:35 PDT 2016


ygao created this revision.
ygao added reviewers: gribozavr, aaron.ballman.
ygao added a subscriber: cfe-commits.

Hi,
I was preparing our internal release documentation with our tech writers, and
when reviewing the clang manual for the current release, we think the current
documentation of type safety attributes are inadequate in a few aspects:

1. The arguments to these attributes are not described.
2. Some of the MPI code examples seem incomplete as they miss declarations.
3. Some references could be made more clear. For example, for the
   "type_tag_for_datatype" attribute, it is mentioned that its optional
   third argument determines "how the expression is compared to the type
   tag", but it is left unspecified what the "expression" is referring to.

We would like to share the edits we have made, both in hope that the edits are
useful to a wider audience, and also to gather some feedback that the new
documentation is still accurate.

Could you review?

- Gao

https://reviews.llvm.org/D22717

Files:
  include/clang/Basic/AttrDocs.td

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D22717.65206.patch
Type: text/x-patch
Size: 10108 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20160723/c140dae9/attachment-0001.bin>


More information about the cfe-commits mailing list