Eu tenho um R
pacote que usa roxygen2
. Ele contém algum C
código /src
e acabei de começar a trabalhar com o Doxygen. Existe alguma maneira de combinar a documentação ou integrar a compilação com o roxygen2? Alguma "prática recomendada" sobre onde colocar a C
documentação do código?
Pesquisar roxygen2 e doxigênio leva principalmente ao roxygen é semelhante aos resultados do doxigênio . Encontrei alguns pacotes com Doxyfiles, mas nenhuma organização consistente. Por exemplo, lme4 tem inst/doc/Doxyfile
saída para uma pasta chamada doxygen
fora do lme4
diretório de origem. Também existe um Doxyfile no diretório raiz do Matrix (mas em versões anteriores estava em inst
. Esta documentação também é exportada fora do diretório do pacote.
Existe alguma razão para não incluir a C
documentação dentro de um pacote, ou por que o Doxygen é tão raramente usado em pacotes R, apesar do uso generalizado de C
?
atualização: consulte a solicitação de recurso roxygen2 relacionada
Respostas:
Eu pessoalmente uso o seguinte código em um pacote "dataManagement" que chamo em todos os meus scripts. Tem documentação e exemplos do Roxygen. Na verdade, você simplesmente chama document () e executa doxygen no código C, em src /. O documento é colocado em inst / doxygen para que seu pacote esteja pronto para CRAN.
A documentação R sendo projetada para usuários finais R não deveria olhar para o código C Eu não integrei a documentação do código C na documentação R clássica, mas provavelmente seria uma boa prática copiar a documentação C resultante como uma "vinheta" .
fonte
devtools::document
para adicionar uma chamada de sistemadoxygen path/to/Doxyfile
. Eu adicionei isso ao meu pacote. Também adicionei uma solicitação de recurso no repositório github roxygen2 @hadley