documentation - Show function definition on class page and topic page - Stack Overflow

admin管理员组

文章数量:1225567

Is is possible to set up Doxygen so that the detailed function definition blocks are shown on both class and topic pages?

Say I had the following class, with Doxygen comments above the method foo(). By default, the Class Reference page for MyClass would contain a brief declaration for foo(), which would include only the \brief comment. If I click on this declaration, it would take me to the longer definition of foo(), which would be in the separate MyGroup page. This would include the \details comment and stuff like parameters etc. Is it possible to setup Doxygen so that the brief declaration and detailed definition of foo() both exist on the Class Reference page for MyClass? Then the MyGroup page would merely contain duplicates of these. I think the context-shift going from class documentation to group documentation can be a little jarring.

class MyClass {
public:
    /// \ingroup MyGroup
    /// \brief Calculate something
    /// \details The calculation implements this technique...
    void foo() {}
};

I am using Doxygen 1.13.2 running on Ubuntu 24.04.

本文标签： documentationShow function definition on class page and topic pageStack Overflow