[clang] -Wdocumentation chockes on @discussion + newline

Originator:kemenaran
Number:rdar://14121497 Date Originated:11-Jun-2013 03:38 PM
Status:Closed Resolved:
Product:Developer Tools Product Version:Xcode5-DP (5A11314m)
Classification:Other Bug Reproducible:Always
 
Summary:

Enabling the -Wdocumentation flag issues warnings for @discussion headerdoc tags immediately followed by a new line.

Steps to Reproduce:

1. Enable the -Wdocumentation warnings
2. Enter some headerdoc comments under the form:

/// foo
///
/// @discussion
/// bar baz
///

3. Compile

Expected Results:

The compiler doesn't output any documentation-related warnings.

Actual Results:

The compiler outputs a warning: "error: empty paragraph passed to '@discussion' command [-Werror,-Wdocumentation]
 @discussion
 ~~~~~~~~~~~^"

Comments

Closed. The example provided actually works now.

Clang still chokes on @discussions with no content, but that is expected.

By kemenaran at June 27, 2013, 1:18 p.m. (reply...)

Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!