Skip to content

C++ API

The C++ API documentation is generated by Doxygen from the sources of lima_common, lima_linguisticprocessing and deeplima.

:material-api: Browse the C++ API documentation

Good entry points:

  • Lima::LinguisticProcessing::AbstractLinguisticProcessingClient and the LinguisticProcessingClientFactory: running an analysis from C++;
  • Lima::MediaProcessUnit and Lima::ProcessUnitPipeline: process units and pipelines;
  • Lima::AnalysisContent and Lima::AnalysisData: the data passed along a pipeline;
  • Lima::Common::MediaticData::MediaticData: global runtime data (languages, entity types, resources).

See Architecture for how these pieces fit together.

To build this documentation locally, run from the repository root:

doxygen docs/Doxyfile   # output in build/doxygen/html/