Use Doxygen comments for C files

1 files changed, 29 insertions, 29 deletions

diff --git a/src/html_common.hh b/src/html_common.hh
index 6f086f5f..cf99d8e6 100644
--- a/src/html_common.hh
+++ b/src/html_common.hh
@@ -19,16 +19,16 @@
  * Macros
  */
 
-// "html struct" to Textblock
+/** "html struct" to Textblock */
 #define HT2TB(html)  ((Textblock*)(html->dw))
-// "html struct" to "Layout"
+/** "html struct" to "Layout" */
 #define HT2LT(html)  ((Layout*)html->bw->render_layout)
-// "Image" to "Dw Widget"
+/** "Image" to "Dw Widget" */
 #define IM2DW(Image)  ((Widget*)Image->dw)
-// Top of the parsing stack
+/** Top of the parsing stack */
 #define S_TOP(html)  (html->stack->getRef(html->stack->size()-1))
 
-// Add a bug-meter message.
+/** Add a bug-meter message. */
 #define BUG_MSG(...)                               \
    D_STMT_START {                                  \
          html->bugMessage(__VA_ARGS__);            \
@@ -56,10 +56,10 @@ typedef enum {
 } DilloHtmlParseMode;
 
 typedef enum {
-   DILLO_HTML_TABLE_MODE_NONE,  /* no table at all */
-   DILLO_HTML_TABLE_MODE_TOP,   /* outside of <tr> */
-   DILLO_HTML_TABLE_MODE_TR,    /* inside of <tr>, outside of <td> */
-   DILLO_HTML_TABLE_MODE_TD     /* inside of <td> */
+   DILLO_HTML_TABLE_MODE_NONE,  /**< no table at all */
+   DILLO_HTML_TABLE_MODE_TOP,   /**< outside of <tr> */
+   DILLO_HTML_TABLE_MODE_TR,    /**< inside of <tr>, outside of <td> */
+   DILLO_HTML_TABLE_MODE_TD     /**< inside of <td> */
 } DilloHtmlTableMode;
 
 typedef enum {
@@ -111,15 +111,15 @@ typedef struct {
    DilloHtmlListMode list_type;
    int list_number;
 
-   /* TagInfo index for the tag that's being processed */
+   /** TagInfo index for the tag that's being processed */
    int tag_idx;
 
    dw::core::Widget *textblock, *table;
 
-   /* This is used to align list items (especially in enumerated lists) */
+   /** This is used to align list items (especially in enumerated lists) */
    dw::core::Widget *ref_list_item;
 
-   /* This is used for list items etc; if it is set to TRUE, breaks
+   /** This is used for list items etc. If it is set to TRUE, breaks
       have to be "handed over" (see Html_add_indented and
       Html_eventually_pop_dw). */
    bool hand_over_break;
@@ -168,31 +168,31 @@ public:  //BUG: for now everything is public
    lout::misc::SimpleVector<DilloHtmlState> *stack;
    StyleEngine *styleEngine;
 
-   int InFlags; /* tracks which elements we are in */
+   int InFlags; /**< tracks which elements we are in */
 
    Dstr *Stash;
    bool StashSpace;
 
-   int pre_column;        /* current column, used in PRE tags with tabs */
-   bool PreFirstChar;     /* used to skip the first CR or CRLF in PRE tags */
-   bool PrevWasCR;        /* Flag to help parsing of "\r\n" in PRE tags */
-   bool PrevWasOpenTag;   /* Flag to help deferred parsing of white space */
-   bool InVisitedLink;    /* used to 'contrast_visited_colors' */
-   bool ReqTagClose;      /* Flag to close the stack's top tag */
-   bool TagSoup;          /* Flag to enable the parser's cleanup functions */
-   bool loadCssFromStash; /* current stash content should be loaded as CSS */
-   bool PrevWasBodyClose; /* set when </body> is found */
-   bool PrevWasHtmlClose; /* set when </html> is found */
-
-   /* element counters: used for validation purposes.
+   int pre_column;        /**< current column, used in PRE tags with tabs */
+   bool PreFirstChar;     /**< used to skip the first CR or CRLF in PRE tags */
+   bool PrevWasCR;        /**< Flag to help parsing of "\r\n" in PRE tags */
+   bool PrevWasOpenTag;   /**< Flag to help deferred parsing of white space */
+   bool InVisitedLink;    /**< used to 'contrast_visited_colors' */
+   bool ReqTagClose;      /**< Flag to close the stack's top tag */
+   bool TagSoup;          /**< Flag to enable the parser's cleanup functions */
+   bool loadCssFromStash; /**< current stash content should be loaded as CSS */
+   bool PrevWasBodyClose; /**< set when </body> is found */
+   bool PrevWasHtmlClose; /**< set when </html> is found */
+
+   /** element counters: used for validation purposes.
     * ATM they're used as three state flags {0,1,>1} */
    uchar_t Num_HTML, Num_HEAD, Num_BODY, Num_TITLE;
 
-   Dstr *attr_data;       /* Buffer for attribute value */
+   Dstr *attr_data;       /**< Buffer for attribute value */
 
-   int32_t non_css_link_color; /* as provided by link attribute in BODY */
-   int32_t non_css_visited_color; /* as provided by vlink attribute in BODY */
-   int32_t visited_color; /* as computed according to CSS */
+   int32_t non_css_link_color; /**< as provided by link attribute in BODY */
+   int32_t non_css_visited_color; /**< as provided by vlink attribute in BODY */
+   int32_t visited_color; /**< as computed according to CSS */
 
    /* -------------------------------------------------------------------*/
    /* Variables required after parsing (for page functionality)          */