Forum: PC-Programmierung Doxygen: Enum-Felder Gemeinsamkeiten dokumentieren


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.
von Walter T. (nicolas)


Lesenswert?

Guten Morgen,

ich bin gerade dabei, Teile eines alten Projektteils in Doxygen zu 
übernehmen. Dabei gibt es ein großes Enum (Offset-Tabelle), bei dem oft 
mehre Felder hintereinander Gemeinsamkeiten haben, aber natürlich auch 
Einzel-Eigenschaften:
1
    /** Font header data offsets:
2
       All Font header data is uncompressed */
3
    enum u8g2_font_header_offset_e
4
    {
5
        u8g2_font_header_offset_number_of_glyphs = 0,
6
        u8g2_font_header_offset_bounding_box_mode = 1,
7
        u8g2_font_header_offset_bits_per_0 = 2,            /**< Encoding run lenght (Zeros) */
8
        u8g2_font_header_offset_bits_per_1 = 3,            /**< Encoding run lenght (Ones) */
9
10
        /* Encoding lengths of glyph bounding box components */
11
        u8g2_font_header_offset_bits_per_char_width = 4,
12
        u8g2_font_header_offset_bits_per_char_height = 5,
13
        u8g2_font_header_offset_bits_per_char_x = 6,
14
        u8g2_font_header_offset_bits_per_char_y = 7,
15
        u8g2_font_header_offset_bits_per_delta_x = 8,
16
17
        /* Font Bounding box; bytes are int8_t */
18
        u8g2_font_header_offset_max_char_width = 9,
19
        u8g2_font_header_offset_max_char_height = 10,
20
        u8g2_font_header_offset_x_offset = 11,
21
        u8g2_font_header_offset_y_offset = 12,
22
23
        /* Ascent and Descent of selected characters 'A', 'g' and '(' for specifc
24
           calculation of line pitch
25
           bytes are int8_t */
26
        u8g2_font_header_offset_ascent_A = 13,
27
        u8g2_font_header_offset_descent_g = 14,
28
        u8g2_font_header_offset_ascent_parenthesis = 15,
29
        u8g2_font_header_offset_descent_parenthesis = 16,
30
31
        /* Start Posistion (Offset) of specific Glyphs ('A', 'a', 255) in Font Array.
32
           This accelerates search for the correct glyph. Would still work, if all
33
           zeroes, thus slower */
34
        u8g2_font_header_offset_start_pos_upper_A = 17,   /**< Glyphs starting from 'A' */
35
        u8g2_font_header_offset_start_pos_lower_a = 19,   /**< Glyphs starting from 'a' */
36
        u8g2_font_header_offset_start_pos_unicode = 21,   /**< Glyphs starting from 255 */
37
    };

Bei normalen Kommentaren kann ich das ja einfach optisch gruppieren, wie 
es oben zu sehen ist. Gibt es einen Weg in Doxygen?

: Bearbeitet durch User

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]
  • [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.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

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