doxygen2docusaurus package

A CLI application to convert Doxygen XML files into Docusaurus documentation.

Remarks

This tool facilitates the integration of Doxygen reference pages into Docusaurus documentation sites. It parses Doxygen-generated XML files and produces Docusaurus .md documents, along with the corresponding sidebars and menu entries.

Classes

Class	Description
BaseCompoundRefDataModel
BriefDescriptionDataModel
CliOptions	Options, as seen by the application. Most are mandatory.
CodeLineDataModel
CompoundDefDataModel
DataModel
DefValDataModel
DerivedCompoundRefDataModel
DescriptionDataModel
DetailedDescriptionDataModel
DoxygenFileDataModel
DoxygenFileOptionDataModel
DoxygenIndexDataModel
DoxygenXmlParser	The DoxygenXmlParser class is responsible for parsing Doxygen-generated XML files and constructing the internal data model.
EnumValueDataModel
HighlightDataModel
InbodyDescriptionDataModel
IncludedByDataModel
IncludesDataModel
IndexCompoundDataModel
IndexMemberDataModel
InitializerDataModel
InnerClassDataModel
InnerDirDataModel
InnerFileDataModel
InnerGroupDataModel
InnerNamespaceDataModel
InnerPageDataModel
ListOfAllMembersDataModel
LocationDataModel
MemberDataModel
MemberDefDataModel
MemberRefDataModel
ParamDataModel
ProgramListingDataModel
ReferenceDataModel
ReferencedByDataModel
ReimplementDataModel
SectionDefDataModel
TableOfContentsDataModel
TemplateParamListDataModel
TocSectDataModel
TypeConstraintDataModel
TypeDataModel

Abstract Classes

Abstract Class	Description
AbstractCodeLineType
AbstractCompoundDefType
AbstractCompoundRefType
AbstractDataModelBase
AbstractDescriptionType
AbstractDocImageType
AbstractDoxygenFileOptionType
AbstractDoxygenFileType
AbstractEnumValueType
AbstractHighlightType
AbstractIncType
AbstractIndexCompoundType
AbstractIndexDoxygenType
AbstractIndexMemberType
AbstractLinkedTextType
AbstractListingType
AbstractListingTypeBase
AbstractListOfAllMembersType
AbstractLocationType
AbstractMemberBaseType
AbstractMemberDefType
AbstractMemberRefType
AbstractMemberType
AbstractParamType
AbstractReferenceType
AbstractRefType
AbstractReimplementType
AbstractSectionDefType
AbstractSectionDefTypeBase
AbstractTableOfContentsKindType
AbstractTableOfContentsType
AbstractTemplateParamListType

Functions

Function	Description
main(argv)	Main entry point for the doxygen2docusaurus CLI tool.

Interfaces

Interface	Description
XmlElement

Type Aliases

Type Alias	Description
[CliConfigurationOptions](/doxygen2docusaurus-cli-ts/docs/api/doxygen2docusaurus/type aliases/cliconfigurationoptions)	Options, as written by the user. All are optional.
[CommandOptions](/doxygen2docusaurus-cli-ts/docs/api/doxygen2docusaurus/type aliases/commandoptions)
[MultiConfigurations](/doxygen2docusaurus-cli-ts/docs/api/doxygen2docusaurus/type aliases/multiconfigurations)	Options, when multi-configurations are used.