CODEWITHSUNDEEP
doxygen
Pavel Drexler
Pavel Drexler

Reputation: 41

doxygen ignore part of variable definition

I would like to ask if you know a way how to make Doxygen ignore some keywords in code. I use C in automation project (created in B+R Automation Studio) so there are Local and Global variables definitions.

Example:

_Local int variable1

_Global int variable2

This causes problems to Doxygen generated documentation.

What I need is to ignore bold part of variable definition but I only found a way how to ignore bigger part of code (unfortunately syntax have to stay exactly as in example).

Thank you for your advice and/or answers. Cheers,

Pavel

Upvotes: 2

Views: 522

Answers (1)

albert
albert

Reputation: 9077

The possibilities doxygen has for this are:

  • create an INPUT_FILTER filtering away the unwanted parts
  • have a look at the preprocessing possibilities and define all names
  • define all the names in an include file and include this file conditionally and run with preprocessing

For all possibilities see the documentation in the configuration file section

Upvotes: 1

Related Questions