mikrocontroller.net

Forum: PC-Programmierung Doxygen: Verschachtelte Structs auf eine Seite


Announcement: there is an English version of this forum on EmbDev.net. Posts you create there will be displayed on Mikrocontroller.net and EmbDev.net.
Autor: Walter T. (nicolas)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hallo zusammen,

ich habe ein großes struct, dessen Felder ebenfalls structs sind 
(Anwendung: Einstellungsdaten). Im Quelltext ist das relativ 
übersichtlich. Hier ein Ausschnitt:
    /** Globale Einstellungen
     *
     * lorem ipsum dolor sit amet bla bla bla und so weiter */
    typedef struct Settings_s
    {
        /** Benutzereingaben */
        struct Input_s
        {
            bool encoderAcceleration;   /**< Drehgeber-Beschleunigung An/Aus */
            int8_t encoderIncrement;    /**< Drehgeber-Schrittweite */
            uint16_t longkeypress_ms;   /**< Mindest-Dauer eines langen Tastendrucks */
        }
        Input;

        /** Einstellungen bezueglich Hardwareaufbaus (PCB) - nicht aenderbar geplant */
        struct SettingPCB_s
        {
            uint16_t VDD_mV;            /**< Versorungsspannung des Digitalteils [mV] */
            uint16_t VSupplyRHigh_Ohm;  /**< Spannungsteiler Supply: Oberer Zweig */
            uint16_t VSupplyRLow_Ohm;   /**< Spannungsteiler Supply: Unterer Zweig */
        }
        SettingPCB;

        // usw.
    }
    Settings_t;

Mit Doxygen entstehen daraus mehrere Seiten, weil jedes Unter-Struct auf 
eine eigene Seite gebracht wird. Damit ist das entstandene Dokument 
schlechter lesbar als der Quelltext.


TL:DR: Kann man Doxygen beibringen, ein struct mit Unter-structs auf 
einer Seite darzustellen?

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.