How to make an introduction page with Doxygen

后端 未结 6 1984
小蘑菇
小蘑菇 2020-12-02 05:42

I made documentation for my SDK, using Doxygen. It contains the list of files, namespaces, classes, types etc. - everything that I placed as Doxygen comments in the code. No

6条回答
  •  有刺的猬
    2020-12-02 06:10

    Following syntax may help for adding a main page and related subpages for doxygen:

    /*! \mainpage Drawing Shapes
     *
     * This project helps user to draw shapes.
     * Currently two types of shapes can be drawn:
     * - \subpage drawingRectanglePage "How to draw rectangle?"
     *
     * - \subpage drawingCirclePage "How to draw circle?"
     *
     */ 
    
    /*! \page drawingRectanglePage How to draw rectangle?
     *
     * Lorem ipsum dolor sit amet
     *
     */
    
    /*! \page drawingCirclePage How to draw circle?
     *
     * This page is about how to draw a circle.
     * Following sections describe circle:
     * - \ref groupCircleDefinition "Definition of Circle"
     * - \ref groupCircleClass "Circle Class"
     */
    

    Creating groups as following also help for designing pages:

    /** \defgroup groupCircleDefinition Circle Definition
     * A circle is a simple shape in Euclidean geometry.
     * It is the set of all points in a plane that are at a given distance from a given point, the centre;
     * equivalently it is the curve traced out by a point that moves so that its distance from a given point is constant.
     * The distance between any of the points and the centre is called the radius.
     */
    

    An example can be found here

提交回复
热议问题