Page MenuHomePhabricator

Improve documentation of the type safety attributes
ClosedPublic

Authored by ygao on Jul 22 2016, 6:30 PM.

Details

Summary

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

Diff Detail

Repository
rL LLVM

Event Timeline

ygao updated this revision to Diff 65206.Jul 22 2016, 6:30 PM
ygao retitled this revision from to Improve documentation of the type safety attributes.
ygao updated this object.
ygao added reviewers: gribozavr, aaron.ballman.
ygao added a subscriber: cfe-commits.
aaron.ballman accepted this revision.Jul 23 2016, 9:00 AM
aaron.ballman edited edge metadata.

LGTM, thank you for improving the documentation!

This revision is now accepted and ready to land.Jul 23 2016, 9:00 AM
This revision was automatically updated to reflect the committed changes.