After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 720046 - Document inline objective-C blocks
Document inline objective-C blocks
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.5
Other Mac OS
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-12-08 02:25 UTC by Jasper Blues
Modified: 2013-12-24 19:00 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Jasper Blues 2013-12-08 02:25:55 UTC
In this file: 

. . . http://www.typhoonframework.org/docs/latest/api/interface_typhoon_patcher.html

the method parameters containing inline blocks don't show up correctly. Is there a way to fix this?

Do typedef'd blocks work?

Here's is the source for the file being documented: https://github.com/jasperblues/Typhoon/blob/master/Source/Test/TyphoonTestUtils.h
Comment 1 Dimitri van Heesch 2013-12-08 12:46:20 UTC
With typedef it should already work. You can associate the typedef's with the interface using @relates, i.e.

/** @relates TyphoonTestUtils */
typedef BOOL (^TyphoonAsynchConditionBlock)();

/** @relates TyphoonTestUtils */
typedef void (^TyphoonTestAssertionsBlock)();

An alternative to document globals is using @file.
Comment 2 Jasper Blues 2013-12-08 12:50:20 UTC
Yes, confirmed that it works with typedef. 

Updated the StackOverflow issue to recommend work-around: 
http://stackoverflow.com/questions/20441528/doxygen-document-method-taking-in-line-block
Comment 3 Dimitri van Heesch 2013-12-08 12:59:54 UTC
Using block types inline should be fixed in the next GIT update.
Comment 4 Jasper Blues 2013-12-08 13:03:23 UTC
Great!

Just a quick question: How do git updates relate to version numbers . . I think we need a tag do publish a spec to MacPorts, Homebrew, etc?

(I usually install Doxygen via MacPorts, given I'm on OSX most of the time lately).
Comment 5 Dimitri van Heesch 2013-12-24 19:00:02 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.6. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferrably in the form of a self-contained example).