Tracking issue: Support for Doxygen commands

[Techie-Pi]

This info is currently outdated!

List of Doxygen commands and their status

• [ ] \addtogroup [(title)]
• [ ] \callgraph
• [ ] \hidecallgraph
• [ ] \callergraph
• [ ] \hidecallergraph
• [ ] \showrefby
• [ ] \hiderefby
• [ ] \showrefs
• [ ] \hiderefs
• [ ] \category [] []
• [x] ~~\class [] []~~ - Won't be supported
• [ ] \concept
• [ ] ~~\def ~~ - Constant defs are not supported by bindgen anyway
• [ ] \defgroup (group title)
• [ ] \dir []
• [x] ~~\enum ~~ Won't be supported
• [ ] \example['{lineno}']
• [ ] \endinternal
• [ ] \extends
• [ ] \file []
• [ ] \fn (function declaration)
• [ ] \headerfile []
• [ ] \hideinitializer
• [ ] \idlexcept
• [ ] \implements
• [ ] \ingroup ( []*)
• [ ] \interface [] []
• [ ] \internal
• [ ] \mainpage [(title)]
• [ ] \memberof
• [x] \name [(header)]
• [ ] \namespace
• [ ] \nosubgrouping
• [ ] \overload [(function declaration)]
• [ ] \package
• [ ] \page (title)
• [ ] \private
• [ ] \privatesection
• [ ] \property (qualified property name)
• [ ] \protected
• [ ] \protectedsection
• [ ] \protocol [] []
• [ ] \public
• [ ] \publicsection
• [ ] \pure
• [ ] \relates
• [ ] \related
• [ ] \relatesalso
• [ ] \relatedalso
• [ ] \showinitializer
• [ ] \static
• [ ] \struct [] []
• [ ] \typedef (typedef declaration)
• [ ] \union [] []
• [ ] \var (variable declaration)
• [x] ~~\vhdlflow [(title for the flow chart)]~~ Won't be supported
• [ ] \weakgroup [(title)]
• [ ] \attention { attention text }
• [ ] \author { list of authors }
• [ ] \authors { list of authors }
• [x] \brief { brief description }
• [ ] \bug { bug description }
• [ ] \cond [(section-label)]
• [ ] \copyright { copyright description }
• [ ] \date { date description }
• [x] \deprecated { description }
• [x] \details { detailed description }
• [ ] \noop ( text to be ignored )
• [ ] \raisewarning ( text to be shown as warning )
• [ ] \else
• [ ] \elseif (section-label)
• [ ] \endcond
• [ ] \endif
• [ ] \exception { exception description }
• [ ] \if (section-label)
• [ ] \ifnot (section-label)
• [ ] \invariant { description of invariant }
• [x] \note { text }
• [ ] \par [(paragraph title)] { paragraph }
• [x] \param '['dir']' { parameter description }
• [ ] \parblock
• [ ] \endparblock
• [ ] \tparam { description }
• [ ] \post { description of the postcondition }
• [ ] \pre { description of the precondition }
• [ ] \remark { remark text }
• [ ] \remarks { remark text }
• [ ] \result { description of the result value }
• [x] \return { description of the return value }
• [x] \returns { description of the return value }
• [x] \retval { description }
• [x] \sa { references }
• [x] \see { references }
• [x] \short { short description }
• [ ] \since { text }
• [ ] \test { paragraph describing a test case }
• [ ] \throw { exception description }
• [ ] \throws { exception description }
• [x] \todo { paragraph describing what is to be done }
• [ ] \version { version number }
• [x] \warning { warning message }
• [ ] \xrefitem "(heading)" "(list title)" { text }
• [ ] \addindex (text)
• [ ] \anchor
• [ ] \cite
• [ ] \endlink
• [ ] \link
• [x] \ref ["(text)"]
• [ ] \refitem
• [ ] \secreflist
• [ ] \endsecreflist
• [ ] \subpage ["(text)"]
• [ ] \tableofcontents['{'[option[:level]][,option[:level]]*'}']
• [ ] \section (section title)
• [ ] \subsection (subsection title)
• [ ] \subsubsection (subsubsection title)
• [ ] \paragraph (paragraph title)
• [ ] \dontinclude['{lineno}']
• [ ] \include['{'option'}']
• [ ] \includelineno
• [ ] \includedoc
• [ ] \line ( pattern )
• [ ] \skip ( pattern )
• [ ] \skipline ( pattern )
• [ ] \snippet['{'option'}'] ( block_id )
• [ ] \snippetlineno ( block_id )
• [ ] \snippetdoc ( block_id )
• [ ] \until ( pattern )
• [ ] \verbinclude
• [ ] \htmlinclude ["[block]"]
• [ ] \latexinclude
• [ ] \rtfinclude
• [ ] \maninclude
• [ ] \docbookinclude
• [ ] \xmlinclude
• [x] \a
• [ ] \arg { item-description }
• [ ] \b
• [ ] \c
• [x] \code['{''}']
• [ ] \copydoc
• [ ] \copybrief
• [ ] \copydetails
• [ ] \docbookonly
• [ ] \dot ["caption"] [=]
• [x] \emoji "name"
• [ ] \msc ["caption"] [=]
• [ ] \startuml ['{'option[,option]'}'] ["caption"] [=]
• [ ] \dotfile ["caption"] [=]
• [ ] \mscfile ["caption"] [=]
• [ ] \diafile ["caption"] [=]
• [x] \e
• [x] \em
• [x] \endcode
• [ ] \enddocbookonly
• [ ] \enddot
• [ ] \endmsc
• [ ] \enduml
• [ ] \endhtmlonly
• [ ] \endlatexonly
• [ ] \endmanonly
• [ ] \endrtfonly
• [ ] \endverbatim
• [ ] \endxmlonly
• [ ] \f$
• [ ] \f(
• [ ] \f)
• [ ] \f[
• [ ] \f]
• [ ] \f{environment}{
• [ ] \f}
• [ ] \htmlonly ["[block]"]
• [ ] \image['{'option[,option]'}'] ["caption"] [=]
• [ ] \latexonly
• [ ] \manonly
• [ ] \li { item-description }
• [ ] \n
• [ ] \p
• [ ] \rtfonly
• [ ] \verbatim
• [ ] \xmlonly
• [ ] \
• [ ] @
• [ ] ~[LanguageId]
• [ ] &
• [ ] $
• [ ] #
• [ ] <
• [ ] >
• [ ] %
• [ ] "
• [ ] .
• [ ] =
• [ ] ::
• [ ] |
• [ ] --
• [ ] ---

Rel: https://github.com/rust-lang/rust-bindgen/issues/955