FullComment

Undocumented

Convert a given full parsed comment to an HTML fragment. Specific details of HTML layout are subject to change. Don’t try to parse this HTML back into an AST, use other APIs instead. Currently the following CSS classes are used:

• para-brief for \brief paragraph and equivalent commands
• para-returns for \returns paragraph and equivalent commands
• word-returns for the Returns word in \returns paragraph. Function argument documentation is rendered as a

  list with arguments sorted in function prototype order. CSS classes used:

• param-name-index-NUMBER for parameter name (
  )
• param-descr-index-NUMBER for parameter description (
  )
• param-name-index-invalid and param-descr-index-invalid are used if parameter index is invalid. Template parameter documentation is rendered as a

  list with parameters sorted in template parameter list order. CSS classes used:

• tparam-name-index-NUMBER for parameter name (
  )
• tparam-descr-index-NUMBER for parameter description (
  )
• tparam-name-index-other and tparam-descr-index-other are used for names inside template template parameters
• tparam-name-index-invalid and tparam-descr-index-invalid are used if parameter position is invalid.

Convert a given full parsed comment to an XML document. A Relax NG schema for the XML can be found in comment-xml-schema.rng file inside the clang source tree.