mikrocontroller.net

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)


Bewertung
0 lesenswert
nicht 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:
    /** Font header data offsets:
       All Font header data is uncompressed */
    enum u8g2_font_header_offset_e
    {
        u8g2_font_header_offset_number_of_glyphs = 0,
        u8g2_font_header_offset_bounding_box_mode = 1,
        u8g2_font_header_offset_bits_per_0 = 2,            /**< Encoding run lenght (Zeros) */
        u8g2_font_header_offset_bits_per_1 = 3,            /**< Encoding run lenght (Ones) */

        /* Encoding lengths of glyph bounding box components */
        u8g2_font_header_offset_bits_per_char_width = 4,
        u8g2_font_header_offset_bits_per_char_height = 5,
        u8g2_font_header_offset_bits_per_char_x = 6,
        u8g2_font_header_offset_bits_per_char_y = 7,
        u8g2_font_header_offset_bits_per_delta_x = 8,

        /* Font Bounding box; bytes are int8_t */
        u8g2_font_header_offset_max_char_width = 9,
        u8g2_font_header_offset_max_char_height = 10,
        u8g2_font_header_offset_x_offset = 11,
        u8g2_font_header_offset_y_offset = 12,

        /* Ascent and Descent of selected characters 'A', 'g' and '(' for specifc
           calculation of line pitch
           bytes are int8_t */
        u8g2_font_header_offset_ascent_A = 13,
        u8g2_font_header_offset_descent_g = 14,
        u8g2_font_header_offset_ascent_parenthesis = 15,
        u8g2_font_header_offset_descent_parenthesis = 16,

        /* Start Posistion (Offset) of specific Glyphs ('A', 'a', 255) in Font Array.
           This accelerates search for the correct glyph. Would still work, if all
           zeroes, thus slower */
        u8g2_font_header_offset_start_pos_upper_A = 17,   /**< Glyphs starting from 'A' */
        u8g2_font_header_offset_start_pos_lower_a = 19,   /**< Glyphs starting from 'a' */
        u8g2_font_header_offset_start_pos_unicode = 21,   /**< Glyphs starting from 255 */
    };



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]
  • [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.