[PATCH] D35379: Add documentation for @available

Sidney San Martín via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Jul 14 09:21:32 PDT 2017


sdy added inline comments.


================
Comment at: docs/LanguageExtensions.rst:1274
 
+Objective-C @available
+----------------------
----------------
I think "Objective-C" is redundant, this is already in the ObjC section and most of the other headers don't start with "Objective-C".


================
Comment at: docs/LanguageExtensions.rst:1274
 
+Objective-C @available
+----------------------
----------------
sdy wrote:
> I think "Objective-C" is redundant, this is already in the ObjC section and most of the other headers don't start with "Objective-C".
`@available` should probably be wrapped in backticks.


================
Comment at: docs/LanguageExtensions.rst:1278
+It is possible use the newest SDK but still build a program that can run on
+older macOS and iOS versions, by passing ``-mmacosx-version-info=`` /
+``--miphoneos-version-min=``.
----------------
arphaman wrote:
> Nit: older versions of macOS or iOS
I thought this flag was `--mmacosx-version-min`?
Nit: I would remove the comma after "versions".


================
Comment at: docs/LanguageExtensions.rst:1317
+
+The ``*`` means that platforms not explicitly listed will take the true branch,
+and the compiler will emit ``-Wunguarded-availability`` warnings for unlisted
----------------
I would say "The * **is required** and means…"


================
Comment at: docs/LanguageExtensions.rst:1331
+If the caller of ``my_fun()`` already checks that ``my_fun()`` is only called
+on 10.12, then add an `availability attributes
+<http://clang.llvm.org/docs/AttributeReference.html#availability>`_ to it,
----------------
attributes ➔ attribute


================
Comment at: docs/LanguageExtensions.rst:1333
+<http://clang.llvm.org/docs/AttributeReference.html#availability>`_ to it,
+which will also suppress the warning:
+
----------------
Maybe something like "…which will suppress the warning and require that calls to `my_fun()` are checked."


https://reviews.llvm.org/D35379





More information about the cfe-commits mailing list