Документация Doxygen для атрибута ".tp_doc" python… - PullRequest
0 голосов
/ 27 ноября 2018

У меня есть библиотека классов со всей документацией doxygen , расположенной в файле c-header ... теперь у меня есть оболочка API python , использующая python типы и методы , относящиеся к c-api типы и функции

Вопрос… КАК я получаю \ краткое и \ details документация из файла c-heder в атрибут python .tpdoc… ??

очень полезная помощьчто doxygen создает файл index с именем c-function → \ краткое и \ detail информация…? возможно больше?

Я хотел бы прочитать ЭТОТ index файл и добавить информацию в python api.

→ Спасибо за помощь

пример:

/// \brief create a \e master/slave link between the master-parent-context and the slave-parent-context …
///
/// \param[in] ctx the \e master context object as PARENT without a CHILD
/// \slaveid
/// \param[in] slave the \e slave context object as CLIENT-PARENT without a CHILD
/// \retMqErrorE
/// \attention The \e slave-context is owned by the \e master-context.
/// This mean that no other external references should be used and the \e slave-context
/// will be deleted if the \e master-context is be deleted.
MQ_EXTERN enum MqErrorE
MQ_DECL MqSlaveCreate (
  struct MqS * const  ctx,
  MQ_SLAVE_ID const   id,
  struct MqS * const  slave
);

python api…

static PyMethodDef MqC_Methods[] = {
...
    { "SlaveCreate", NS(MqC_SlaveCreate), METH_VARARGS, "\brief doc…" },
...
}
...