documentação Doxygen para python ".tp_doc" atributo ...

votos
0

Eu tenho uma classe-Library com todo o doxygen documentação localizado no arquivo c-header ... agora eu tenho um python API wrapper usando python tipos e métodos relacionados com c-api tipos e funções ...

Pergunta ... como eu fico o \ breve e \ detalhes de documentação fora do arquivo c-heder no python .tpdoc ... atributo ??

uma verdadeira boa ajuda seria que doxygen produzir um indexarquivo com c-function-name → \ breve e \ pormenor informações ...? talvez mais?

Eu lia ESTE index arquivo e adicione as informações para o python api.

→ Obrigado pela ajuda

exemplo:

/// \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… },
...
}
Publicado 27/11/2018 em 18:06
fonte usuário
Em outras línguas...                            

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more