Geek Answers Handbook

Doxygen C Document Functions in Objective-C Projects

I am programming a project in Objective-C, and I started using Doxygen to automatically generate documentation. A significant part of the project contains the basic functions of C. Unfortunately, Doxygen does not document the functions of C, only the Objective-C classes and their methods. I have functions defined in several header files, for example:

BOOL myFunc(void);

What I then implemented in .m.

Doesn't Doxygen detect direct C functions in Objective-C, or is there an option I should enable? Is my function incorrect for Doxygen?

+4
source share
1 answer

Doxygen certainly documents the direct functions of C.

After testing

Use Doxywizard and check the values ​​in expert mode - this gives some nice help when you mouse over things. In particular, you had to change the default value, so EXTRACT_ALL is checked

I think that you need to set this, in front of the default, maybe a mistake.

If desperate, post the settings in the question. I just created a sample from scratch and verified that your function appeared using Doxygen when I use EXTRACT_ALL, but there is no file section if I disable this.

In VTK docs, you will see the functions under the files - file members, as shown here .

Sorry I didn’t take it before, but I always have EXTRACT_ALL, since I work on legacy codes where most functions have no special comments.

earlier idea Try adding an @file comment at the top of the file to see if it is being processed.

  /// @file fred.h This file defines functions used in fred.m

My bet is that the extension of your file or your directory is not included in the doxygen installation file that you are using.

+2
source

More articles:


All Articles