[LLVMbugs] [Bug 15234] New: -Wdocumentation warns on \return tag for @propertys

bugzilla-daemon at llvm.org bugzilla-daemon at llvm.org
Mon Feb 11 07:59:47 PST 2013


            Bug ID: 15234
           Summary: -Wdocumentation warns on \return tag for @propertys
           Product: clang
           Version: 3.2
          Hardware: Macintosh
                OS: MacOS X
            Status: NEW
          Severity: normal
          Priority: P
         Component: Frontend
          Assignee: unassignedclangbugs at nondot.org
          Reporter: fritza at manoverboard.org
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

When documentation warnings are on, documentation comments attached to
properties that include @return (\return) notes are flagged as errors. (Xcode

Steps to Reproduce:

Create an iOS-app target with -Wdocumentation set in Other Warning Flags.

In any convenient class declaration, include the following lines:
///    The full predicate to be used for drawing objects from the store.
///    It is an AND of the parent's `prefixPredicate` (e.g., the selection for
///    volume number) and the `filterPredicate` (selection by matching the
///    @return `nil` if there is no search string, and no prefix.
@property(readonly) NSPredicate *                        andPredicate;
///    The predicate that matches the string to be searched for. This
///    @return `nil` if there is no search string.
@property(readonly) NSPredicate *                        filterPredicate;

Product > Build

Expected Results:

No issues are flagged for this code.

Actual Results:

The comments beginning "/// @return" are given warnings:
 '\return' command used in a comment that is not attached to a function or
method declaration


This is the clang that comes with Xcode 4.6.


Properties are wrappers on methods, and the methods in question may return
signal values that must be documented. It is reasonable to expect that these
should be documented as return values.

You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20130211/7a5912d5/attachment.html>

More information about the llvm-bugs mailing list