Fortran 類型綁定過程的 doxygen 處理

Question

我正在記錄一些 Fortran 類，其中包括使用 doxygen (1.8.10) 的類型綁定過程（成員函數）。 該過程的文檔與包含定義的模塊相關聯。 我希望文檔與其綁定的類型相關聯，但我無法取得良好的結果。

我定義新類型/類的典型方法是定義一個模塊type_newtype ，它只包括新數據類型newtype_t的定義以及類型綁定過程。 此處顯示，包括新數據類型的類型綁定過程。

module type_newtype
    implicit none


    !> Class documentation
    type, public :: newtype_t

        integer(ik)  :: val

    contains

        procedure :: set_val

    end type newtype_t


contains


    !> set val
    !!
    !! @param[in] self
    !! @param[in] i
    subroutine set_val(self,i)
        class(newtype_t),  intent(in)  :: self
        integer(ik),       intent(in)  :: i


        self%val = i

    end subroutine set_val


end module type_newtype

當 doxygen 處理文件時，類型綁定過程的條目顯示在模塊type_newtype ，但不在實際數據類型newtype_t 。

我嘗試將 EXTRACT_ALL 設置為 ON。 這set_val下newtype_t了set_val類型綁定過程的條目，但不包括任何文檔。 沒有簡短，界面中沒有變量。

我的目標是將過程文檔保存在其關聯類型中。 不是模塊。 實際上，兩者都可以，但條目僅在模塊下顯示完整。 我歡迎任何經驗以及關於用法和風格的建議，因為我是 doxygen 的新手。

Answer 1

你可以嘗試設置@copydoc所描述的類型綁定過程在這里：

contains

    procedure :: set_val !< @copydoc type_newtype::set_val

然后應該復制文檔。 但是在我的情況下缺少呼號，這似乎仍然是 doxygen 中的一個錯誤。 見這里。