CODEWITHSUNDEEP
objective-cdoxygen
Matthew Gillingham
Matthew Gillingham

Reputation: 3429

Doxygen documents my Objective-C Code as though it is C++

I want to set up doxygen as the tool to document my Objective C source code. The code generating tool seems to work well, except that the way it renders the descriptions of my Objective C methods makes them look like they are written in C++. I have read through all of the various options in the Doxygen website, but I can't find a combination of options to force it to render a more "Objective-C"-like appearance.

Likewise, editing the doxygenLayout.xml file seems to be useful for changing the names of the different sections, but I don't see how it can be used to change the way that methods are represented. I have included an example below:

My Source Code

The Resulting Documentation

Notice how version has two parenthesis after it, and the class uses two colons between the class name and the method name. Is there a way to change this?

Upvotes: 3

Views: 1515

Answers (2)

Oliver Eichhorn
Oliver Eichhorn

Reputation: 307

If you want to force doxygen to generate documentation for Objective-C, you can use EXTENSION_MAPPING in doxygens config file. For example, if you want to force doxygen to Objective-C for .m and .h files, add the following:

EXTENSION_MAPPING      = m=Objective-C \
                         h=Objective-C

Upvotes: 1

Rob Napier
Rob Napier

Reputation: 299345

Check your Doxyfile for EXTENSION_MAPPING (or try starting with a clean Doxyfile). I've had decent success using Doxygen with ObjC (not perfect, but pretty good) using the default settings.

What version of Doxygen are you using? I'm still using 1.6.1, but I wouldn't expect a massive change in the 1.7 line.

Upvotes: 0

Related Questions