techie-pi / doxygen-rs

Transform Doxygen to Rustdoc

Do you depend on something I maintain? Do you want to start maintaining it yourself? Send me an e-mail.

doxygen-rs's Issues

Publish on Crates.io

Hello,

Is there any reason this isn't published on Crates.io? Even if it's unfinished, a 0.1.x series would make it much nicer to control versions.

Currently the best way is to specify the git hash, e.g.

doxygen-rs = { git = "https://github.com/Techie-Pi/doxygen-rs.git", rev = "a7fee318" }

Tracking issue: Support for Doxygen commands

This info is currently outdated!

List of Doxygen commands and their status

• \addtogroup [(title)]
• \callgraph
• \hidecallgraph
• \callergraph
• \hidecallergraph
• \showrefby
• \hiderefby
• \showrefs
• \hiderefs
• \category [] []
• \class [] [] - Won't be supported
• \concept
• \def - Constant defs are not supported by bindgen anyway
• \defgroup (group title)
• \dir []
• \enum Won't be supported
• \example['{lineno}']
• \endinternal
• \extends
• \file []
• \fn (function declaration)
• \headerfile []
• \hideinitializer
• \idlexcept
• \implements
• \ingroup ( []*)
• \interface [] []
• \internal
• \mainpage [(title)]
• \memberof
• \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)
• \vhdlflow [(title for the flow chart)] Won't be supported
• \weakgroup [(title)]
• \attention { attention text }
• \author { list of authors }
• \authors { list of authors }
• \brief { brief description }
• \bug { bug description }
• \cond [(section-label)]
• \copyright { copyright description }
• \date { date description }
• \deprecated { description }
• \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 }
• \note { text }
• \par [(paragraph title)] { paragraph }
• \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 }
• \return { description of the return value }
• \returns { description of the return value }
• \retval { description }
• \sa { references }
• \see { references }
• \short { short description }
• \since { text }
• \test { paragraph describing a test case }
• \throw { exception description }
• \throws { exception description }
• \todo { paragraph describing what is to be done }
• \version { version number }
• \warning { warning message }
• \xrefitem "(heading)" "(list title)" { text }
• \addindex (text)
• \anchor
• \cite
• \endlink
• \link
• \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
• \a
• \arg { item-description }
• \b
• \c
• \code['{''}']
• \copydoc
• \copybrief
• \copydetails
• \docbookonly
• \dot ["caption"] [=]
• \emoji "name"
• \msc ["caption"] [=]
• \startuml ['{'option[,option]'}'] ["caption"] [=]
• \dotfile ["caption"] [=]
• \mscfile ["caption"] [=]
• \diafile ["caption"] [=]
• \e
• \em
• \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: rust-lang/rust-bindgen#955

Improve wording and structure

Right now, the data goes from a parser to a concrete type-generator (called internally an AST-generator) and finally to a rustdoc-generator.

Maybe it would be a good idea to add a true AST between the raw parsed data and the concrete type.