New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document inline objective-C blocks (Origin: bugzilla #720046) #5372

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.5 on platform Other
Assigned to: Dimitri van Heesch

On 2013-12-08 02:25:55 +0000, Jasper Blues wrote:

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

On 2013-12-08 12:46:20 +0000, Dimitri van Heesch wrote:

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.

On 2013-12-08 12:50:20 +0000, Jasper Blues wrote:

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

On 2013-12-08 12:59:54 +0000, Dimitri van Heesch wrote:

Using block types inline should be fixed in the next GIT update.

On 2013-12-08 13:03:23 +0000, Jasper Blues wrote:

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).

On 2013-12-24 19:00:02 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment