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	Data model for base compound references in inheritance relationships.
BriefDescriptionDataModel	Data model for brief description elements within documentation.
CliOptions	Comprehensive CLI options class for documentation generation configuration.
CodeLineDataModel	Data model for individual code line elements within program listings.
CompoundDefDataModel	Concrete implementation of compound definition data model.
DataModel	Top-level data model class for orchestrating Doxygen XML parsing and data organisation.
DefValDataModel	Data model for default value elements within documentation content.
DerivedCompoundRefDataModel	Data model for derived compound references in inheritance relationships.
DescriptionDataModel	Data model for general description elements within documentation.
DetailedDescriptionDataModel	Data model for detailed description elements within documentation.
DoxygenFileDataModel	Concrete data model class for doxyfile elements.
DoxygenFileOptionDataModel	Concrete data model class for Doxyfile option elements.
DoxygenIndexDataModel	Concrete data model class for doxygenindex elements.
DoxygenXmlParser	XML parser for Doxygen-generated documentation files.
EnumValueDataModel	Concrete implementation of enumeration value data model.
HighlightDataModel	Data model for syntax highlight elements within code listings.
InbodyDescriptionDataModel	Data model for in-body description elements within documentation.
IncludedByDataModel	Data model for includedby elements within documentation content.
IncludesDataModel	Data model for includes elements within documentation content.
IndexCompoundDataModel	Concrete data model class for index compound elements.
IndexMemberDataModel	Concrete data model class for index member elements.
InitializerDataModel	Data model for initializer elements within documentation content.
InnerClassDataModel	Data model for inner class reference elements.
InnerDirDataModel	Data model for inner folder reference elements.
InnerFileDataModel	Data model for inner file reference elements.
InnerGroupDataModel	Data model for inner group reference elements.
InnerNamespaceDataModel	Data model for inner namespace reference elements.
InnerPageDataModel	Data model for inner page reference elements.
ListOfAllMembersDataModel	Concrete implementation for listofallmembers elements within compound documentation.
LocationDataModel	Concrete implementation for location elements within documentation.
MemberDataModel	Concrete implementation for member elements within documentation.
MemberDefDataModel	Concrete implementation for memberdef elements within compound documentation.
MemberRefDataModel	Concrete implementation for member reference elements within documentation.
ParamDataModel	Concrete implementation for parameter elements within function documentation.
ProgramListingDataModel	Data model for programlisting XML elements containing source code.
ReferenceDataModel	Data model for reference relationship elements.
ReferencedByDataModel	Data model for referenced-by relationship elements.
ReimplementDataModel	Data model for reimplement relationship elements.
SectionDefDataModel	Concrete data model for section definition elements.
TableOfContentsDataModel	Concrete data model class for table of contents elements.
TemplateParamListDataModel	Concrete data model class for template parameter list elements.
TocSectDataModel	Concrete data model class for table of contents section elements.
TypeConstraintDataModel	Data model for type constraint elements within documentation content.
TypeDataModel	Data model for type elements within documentation content.

Abstract Classes

Abstract Class	Description
AbstractCodeLineType	Abstract base class for code line elements with syntax highlighting support.
AbstractCompoundDefType	Abstract base class for Doxygen compound definition data models.
AbstractCompoundRefType	Abstract base class for compound reference data models.
AbstractDataModelBase	Abstract base class for all data model elements in the Doxygen XML layer.
AbstractDescriptionType	Abstract base class for Doxygen description elements containing mixed content.
AbstractDocImageType	Abstract base class for image elements within documentation content.
AbstractDoxygenFileOptionType	Abstract base class for Doxygen file option type data models.
AbstractDoxygenFileType	Abstract base class for Doxygen file type data models.
AbstractEnumValueType	Abstract base class for enumeration value data models.
AbstractHighlightType	Abstract base class for syntax highlighting elements within code listings.
AbstractIncType	Abstract base class for include-type elements within documentation.
AbstractIndexCompoundType	Abstract base class for index compound type data models.
AbstractIndexDoxygenType	Abstract base class for Doxygen index type data models.
AbstractIndexMemberType	Abstract base class for index member type data models.
AbstractLinkedTextType	Abstract base class for linked text elements within documentation content.
AbstractListingType	Abstract base class for processing listing-type XML elements with parsing logic.
AbstractListingTypeBase	Abstract base class providing properties for listing-type XML elements.
AbstractListOfAllMembersType	Abstract base class for list-of-all-members elements within documentation.
AbstractLocationType	Abstract base class for location information data models.
AbstractMemberBaseType	Abstract base class for member-related data models within documentation.
AbstractMemberDefType	Abstract base class for comprehensive member definition data models.
AbstractMemberRefType	Abstract base class for member reference data models within documentation.
AbstractMemberType	Abstract base class for member type data models within documentation.
AbstractParamType	Abstract base class for parameter data models within documentation.
AbstractReferenceType	Abstract base class for reference type data models.
AbstractRefType	Abstract base class for reference type data models.
AbstractReimplementType	Abstract base class for reimplement type data models.
AbstractSectionDefType	Abstract class for XML-parsed section definition types.
AbstractSectionDefTypeBase	Abstract base class for section definition type data models.
AbstractTableOfContentsKindType	Abstract base class for table of contents kind type data models.
AbstractTableOfContentsType	Abstract base class for table of contents type data models.
AbstractTemplateParamListType	Abstract base class for template parameter list type data models.

Functions

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

Interfaces

Interface	Description
XmlElement	Represents a generic XML element in the parsed structure.

Type Aliases

Type Alias	Description
CliConfigurationOptions	Configuration options as specified by users in configuration files.
CommandOptions	Command line argument options passed to the application.
MultiConfigurations	Multiple configuration sets for different build scenarios.

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.

Remarks​

Classes​

Abstract Classes​

Functions​

Interfaces​

Type Aliases​