Resultados da pesquisa a pedido "documentation-generation"
O Swift tem suporte para geração de documentação?
Suporte para muitos idiomascomentários de documentaçãopara permitir um gerador (comojavadoc oudoxygen [http://www.stack.nl/~dimitri/doxygen/]) para gerar documentação de código analisando o mesmo código. O Swift tem algum recurso de comentário ...
Qual é a relação entre docutils e Sphinx?
Parece haver uma infinidade de ferramentas de documentação para Python. Outro que eu encontrei é o epydoc. Parece que o Sphinx é o padrão de fato, porque é usado para gerar os documentos oficiais do Python. Alguém pode resolver o estado atual das ...
Substituindo docstrings python [fechado]
Eu escrevi umepytext [http://epydoc.sourceforge.net/epytext.html]paradescansar [http://docutils.sourceforge.net/docs/user/rst/quickref.html]conversor de marcação e agora quero converter todos os documentos em toda a minha biblioteca do formato ...
Como omito os valores das variáveis no Sphinx?
Eu tenho algumas variáveis no nível do módulo que possuem valores longos e desinteressantes que eu gostaria de excluir da documentação gerada automaticamente. Existe uma maneira de fazer isso? Por exemplo, na minha fonte Python eu tenho algo ...
JSDoc: estrutura de objeto de retorno
Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei o@return {{field1: type, field2: type, ...}} description sintaxe e tentei: /** * Returns a coordinate from a given mouse or touch event * ...
O documento sphinx napoleon pode funcionar retornando vários argumentos?
Estou tentando usar o estilo de código do Google para documentar uma função para a qual eu uso esfinge com a extensão napoleon para criar a documentação. A função é incomum, pois retorna dois argumentos. Não acho que Napoleão lide com isso. Se ...
VS2010: arquivos gerados automaticamente e documentação XML
Isso é realmente apenas pedir novamenteesta pergunta feita sobre o Visual Studio 2008 [https://stackoverflow.com/questions/1445723/vs2008-autogenerated-files-and-xml-documentation] . O VS2010 oferece algum recurso para se livrar do aviso do ...
Como usar o LuaDoc com LuaForWindows
A questão está no título: como usar o LuaDoc com o LuaForWindow Na minha instalação Lua, eu tenho um luadoc_start.bat, mas a janela de comando é fechada assim que é aberta. A partir daí, não sei mais o que posso fazer. Qualquer ajuda ? Obrigad
Auto documentando a API REST em PHP
phpDocumentor parece ser o padrão para documentar o código PHP, embora eu tenha que me perguntar por que ele não foi atualizado há anos ..? No entanto, não parece adequado para documentar os pontos de entrada para uma API REST; IE, pontos de ...
VS2010: o arquivo de documentação XML gerado automaticamente não atualiza
Tenho um projeto C # no vs2010 que gera um arquivo de documentação XML, em que defini o caminho de saída do arquivo gerado como o caminho de saída do projet Meu problema é que o arquivo não é atualizado quando o caminho para o arquivo de ...