Doxygen Comments format (.c, .cpp, .h, .java, .m, .py)

The Doxygen format extracts the documentation prose from API comments embedded in C, C++, Objective-C, Java, and Python source files. It recognises the standard Doxygen comment styles — ///, //!, /** */, /*! */, and the trailing ///< and /*!< */ variants — and leaves the surrounding code, command markers, and code or verbatim blocks as non-translatable skeleton, so the file round-trips after merge.

It understands the Doxygen command vocabulary: metadata commands such as \class or \file are skipped, while description commands such as \brief, \param, and \return contribute their description text as translatable blocks. This mirrors Okapi's Doxygen filter and lets you translate inline documentation without touching the code it documents.

IDdoxygen

SourceBuilt-in

Extensions.c, .cpp, .h, .java, .m, .py

MIME Typestext/x-doxygen-txt

CapabilitiesRead + Write

Parameters

Parameter	Type	Default	Description
codeFinderRules	array		Regex patterns that match inline codes within translatable text
preserveWhitespace	boolean	false	Preserve original whitespace in extracted comment text instead of normalizing it
useCodeFinder	boolean	false	Enable regex-based detection of inline codes within translatable text

Configure these parameters interactively and copy the YAML on the Format Reference.

Examples

Preserve comment whitespace

Keep indentation and spacing in pre-formatted comment text.

preserveWhitespace: true

Protect format specifiers

Treat printf-style specifiers as inline codes instead of translating them.

useCodeFinder: true
codeFinderRules:
  - "%[ds]"

Processing notes

• Metadata commands (e.g. \class, \file) are skipped; description commands (e.g. \brief, \param, \return) extract their description text.

• Code and verbatim blocks within comments are preserved as non-translatable skeleton.

← Back to the Format Reference