Home/ Questions/Q 8505807
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-11T02:25:27+00:00

Is it possible to include content within a doxygen comment block that will be

  • 0

Is it possible to include content within a doxygen comment block that will be ignored by doxygen? In order words, can we have comments within a doxygen comment block?

Background:

We’re converting the in-code comments for a Fortran project to a doxygen-parseable format, however the project requires that the content within the in-code comments be delineated by horizontal lines. For example:

!> @brief Lorem ipsum dolor sit amet
!! ---------------------------------------------------------------------
!!
!! @param[in] p1  Description of p1
!! @param[in] p2  Description of p2
!! ---------------------------------------------------------------------
!!
!! More content here ....
!! ---------------------------------------------------------------------
!!
!! More content for another section
!! ---------------------------------------------------------------------
subroutine do_something(p1, p2)
  ! .... the code ...
end subroutine do_something

Is there a command/syntax I can prefix those lines with so that doxygen will ignore them? Hopefully, one that is unobtrusive and does not affect the readability of the comments.

I am aware of the INPUT_FILTER settings which one can use to chain in a preprocessing script, but the ideal solution would be one that does not depend on additional scripts/tools.

P.S. I’m well aware that many would think those horizontal lines unnecessary and/or distracting. However, it is a requirement decreed by the paymaster and is not something that I am at the liberty to change.

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    You could leverage Doxygen’s alias syntax to ignore the line, however it will require that the line be prefixed and suffixed with additional characters. For example, if you defined an alias like:

    ALIASES                = I{1}=""

    You could use the alias in your comment to hide the horizontal breaks from doxygen:

    !> @brief Lorem ipsum dolor sit amet
!! @I{-----------------------------------------------------------------}
!!
!! @param[in] p1  Description of p1
!! @param[in] p2  Description of p2
!! @I{-----------------------------------------------------------------}
!!
!! More content here ....
!! @I{-----------------------------------------------------------------}
!!
!! More content for another section
!! @I{-----------------------------------------------------------------}
subroutine do_something(p1, p2)
  ! .... the code ...
end subroutine do_something
    • 0