Skip to content

GoCarrot/doxygen2adoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doxygen2adoc

Does what it says on the tin.

Examples

Some examples of multi-language usage from our SDKs at Teak. Each SDK builds its docs using doxygen and doxygen2adoc in various languages using configurations and appropriate partial templates.

The generated docs can be found at: http://docs.gocarrot-dev.com

Errors

If you see:

Found __deprecated as a parameter declname, check Doxygen config.

Then Doxygen is parsing an Objective C method such as:

(void)identifyUser:(nonnull NSString*)userId withOptOutList:(nonnull NSArray*)optOut __deprecated;

And treating __deprecated as the name of the parameter. To fix this, use a macro such as:

(void)identifyUser:(nonnull NSString*)userId withOptOutList:(nonnull NSArray*)optOut __deprecated_msg("Use identifyUser:withConfiguration: instead");

Then add the following to your Doxygen config

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = __deprecated_msg(x)=

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •