Doxygen/pt-br: Revision history

Diff selection: Mark the radio buttons of the revisions to compare and hit enter or the button at the bottom.
Legend: (cur) = difference with latest revision, (prev) = difference with preceding revision, m = minor edit.

(newest | oldest) View ( | ) (20 | 50 | 100 | 250 | 500)

19 June 2024

  • curprev 17:2817:28, 19 June 2024Dikluwe talk contribs 43,050 bytes +64 Created page with "=== Verificação de qualidade do código Python ==="
  • curprev 17:2817:28, 19 June 2024Dikluwe talk contribs 42,986 bytes +19 Created page with "Use-o também {{incode|find}} para executar verificações docstring em todos os arquivos de origem."
  • curprev 17:2817:28, 19 June 2024Dikluwe talk contribs 42,967 bytes +12 Created page with "Consulte esta resposta em [https://stackoverflow.com/a/35377654 Stackoverflow] para obter outras alternativas para documentar código C++ e Python juntos no mesmo projeto."
  • curprev 17:2817:28, 19 June 2024Dikluwe talk contribs 42,955 bytes +13 Created page with "Consulte o [https://breathe.readthedocs.io/en/latest/quickstart.html Guia de início rápido] na documentação do Breathe para saber mais sobre esse processo."
  • curprev 17:2717:27, 19 June 2024Dikluwe talk contribs 42,942 bytes +36 Created page with "Embora o Sphinx possa analisar nativamente docstrings do Python, ele requer um pouco mais de trabalho para analisar fontes C++. O projeto [https://breathe.readthedocs.io/en/latest/ Breathe] ([https://github.com/michaeljones/breathe Github]) é uma tentativa de preencher a lacuna entre Sphinx e Doxygen, a fim de integrar a documentação de código fonte Python e C++ no mesmo sistema. Primeiro, o Doxygen precisa ser configurado para gerar um arquivo XML; a saída XML é e..."
  • curprev 17:2617:26, 19 June 2024Dikluwe talk contribs 42,906 bytes +45 Created page with "[https://www.sphinx-doc.org/en/master/ Sphinx]é o sistema mais popular para documentar o código-fonte do Python. No entanto, como as principais funções e bancadas de trabalho do FreeCAD são escritas em C++, considerou-se que o Doxygen é uma melhor ferramenta de documentação para este projeto."
  • curprev 17:2517:25, 19 June 2024Dikluwe talk contribs 42,861 bytes +55 Created page with "== Documentação de origem com Sphinx =="
  • curprev 17:2517:25, 19 June 2024Dikluwe talk contribs 42,806 bytes +4 Created page with "* Documentação de origem * [https://www.freecadweb.org/api/ Site da API FreeCAD]"
  • curprev 17:2417:24, 19 June 2024Dikluwe talk contribs 42,802 bytes +31 Created page with "== Relacionado =="
  • curprev 17:2417:24, 19 June 2024Dikluwe talk contribs 42,771 bytes +134 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> Algumas das palavras-chave mais comuns usadas na documentação do FreeCAD são apresentadas aqui. <div class="mw-collapsible-content"> * <code>\defgroup <name> (group title) </code>, consulte [http://www.doxygen.nl/manual/commands.html#cmddefgroup \defgroup], e [http://www.doxygen.nl/manual/grouping.html Grouping]. * <code>\ingroup (<groupname> [<groupname> <groupname>])</code>, consulte [http://www.doxygen.nl/manual/..."
  • curprev 17:0517:05, 19 June 2024Dikluwe talk contribs 42,637 bytes +56 Created page with "Os comandos podem ter um ou mais argumentos. No manual do Doxygen, os argumentos são descritos a seguir. * Se {{incode|<sharp>}} forem usadas chaves, o argumento será uma única palavra. * Se {{incode|(round)}} forem usadas chaves, o argumento se estenderá até o final da linha na qual o comando foi encontrado. * Se <code>{curly}</code> forem usadas chaves, o argumento se estende até o próximo parágrafo. Os parágrafos são delimitados por uma linha em branco ou po..."
  • curprev 17:0317:03, 19 June 2024Dikluwe talk contribs 42,581 bytes +34 Created page with "Todos os [http://www.doxygen.nl/manual/commands.html comandos da documentação] do Doxygen começam com uma barra invertida {{incode|\}} ou um arroba {{incode|@}}, de sua preferência. Normalmente, a barra invertida {{incode|\}} é usada, mas ocasionalmente {{incode|@}} é usada para melhorar a legibilidade."
  • curprev 17:0017:00, 19 June 2024Dikluwe talk contribs 42,547 bytes +38 Created page with "== Suporte a Markdown =="
  • curprev 16:5916:59, 19 June 2024Dikluwe talk contribs 42,509 bytes +42 Created page with "== Marcações de Doxygen =="
  • curprev 16:5916:59, 19 June 2024Dikluwe talk contribs 42,467 bytes +1 No edit summary
  • curprev 16:5916:59, 19 June 2024Dikluwe talk contribs 42,466 bytes +30 Created page with "o gerar a documentação completa do FreeCAD, você não executa {{incode|doxygen}} diretamente. Em vez disso, o projeto usa {{incode|cmake}} para configurar o ambiente de compilação e, em seguida {{incode|make}}, dispara a compilação dos códigos-fonte do FreeCAD e da documentação do Doxygen; isso é explicado na página de documentação de origem."
  • curprev 16:5716:57, 19 June 2024Dikluwe talk contribs 42,436 bytes +34 Created page with "Se você estiver escrevendo novas classes, funções ou um novo workbench inteiro, é recomendável executar {{incode|doxygen}} periodicamente para ver se os blocos de documentação, Markdown e comandos especiais estão sendo lidos corretamente e se todas as funções públicas estão totalmente documentadas. Leia também as [https://github.com/FreeCAD/FreeCAD/blob/master/src/Doc/doctips.dox dicas de documentação] localizadas..."
  • curprev 16:5416:54, 19 June 2024Dikluwe talk contribs 42,402 bytes +23 Created page with "* A documentação gerada será criada dentro de uma pasta chamada {{incode|toplevel-source/html}}. Ele consistirá em muitas páginas HTML, imagens PNG para gráficos, folhas de estilo em cascata ({{incode|.css}}), arquivos Javascript ({{incode|.js}}) e potencialmente muitos subdiretórios com mais arquivos, dependendo do tamanho do seu código. O ponto de entrada na documentação é {{incode|index.html}}, que você pode abrir com um navegador da Web."
  • curprev 16:5316:53, 19 June 2024Dikluwe talk contribs 42,379 bytes +22 Created page with "* Outra opção é criar o arquivo de configuração do zero e adicionar apenas as tags desejadas com um editor de texto. * Depois que a configuração for salva, você poderá executar o Doxygen neste arquivo de configuração."
  • curprev 16:5316:53, 19 June 2024Dikluwe talk contribs 42,357 bytes +46 Created page with "* Em vez de usar um editor de texto, você pode iniciar {{incode|doxywizard}} para editar muitas tags ao mesmo tempo. Com esta interface você pode definir muitas propriedades, como informações do projeto, tipo de saída (HTML e LaTeX), uso do Graphviz para criar diagramas, mensagens de aviso para exibir, padrões de arquivo (extensões) para documentar ou excluir, filtros de entrada, cabeçalhos e rodapés opcionais para as páginas geradas em HTML, opções para saí..."
  • curprev 16:5216:52, 19 June 2024Dikluwe talk contribs 42,311 bytes +63 Created page with "* Execute {{incode|doxygen -g DoxyDoc.cfg}} para criar um arquivo de configuração chamado {{incode|DoxyDoc.cfg}}. Se você omitir esse nome, o arquivo {{incode|Doxyfile}} ficara sem uma extensão. * Este é um arquivo de texto grande e simples que inclui muitas variáveis com seus valores. No manual do Doxygen essas variáveis são chamadas de "tags". O arquivo de configuração e todas as tags são descritos extensivamente na seção [http://www.doxygen.nl/manual/conf..."
  • curprev 16:5016:50, 19 June 2024Dikluwe talk contribs 42,248 bytes +40 Created page with "* Verifique se você está na mesma pasta que os arquivos de origem ou no diretório de nível superior da árvore de código-fonte, se você tiver muitos arquivos de código-fonte em subdiretórios diferentes."
  • curprev 16:5016:50, 19 June 2024Dikluwe talk contribs 42,208 bytes +2 Created page with "<div class="mw-collapsible-content"> * Certifique-se de ter os programas {{incode|doxygen}} e {{incode|doxywizard}} em seu sistema. Também é recomendado ter o {{incode|dot}} programa do [https://www.graphviz.org/ Graphviz], a fim de gerar diagramas com as relações entre classes e namespaces. Em sistemas Linux, esses programas podem ser instalados a partir do seu gerenciador de pacotes."
  • curprev 16:4316:43, 19 June 2024Dikluwe talk contribs 42,206 bytes −10 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> O processo é descrito a seguir."
  • curprev 16:4316:43, 19 June 2024Dikluwe talk contribs 42,216 bytes +24 Created page with "Para gerar a documentação do código-fonte, há duas etapas básicas: # Crie um arquivo de configuração para controlar como o Doxygen processará os arquivos de origem. # Execute {{incode|doxygen}} nessa configuração."
  • curprev 16:4216:42, 19 June 2024Dikluwe talk contribs 42,192 bytes +17 Created page with "{{Caption|Fluxo de trabalho geral para produzir documentação de código-fonte com o Doxygen.}}"
  • curprev 16:4216:42, 19 June 2024Dikluwe talk contribs 42,175 bytes +47 Created page with "== Compilando a documentação =="
  • curprev 16:4116:41, 19 June 2024Dikluwe talk contribs 42,128 bytes +1 No edit summary
  • curprev 16:4116:41, 19 June 2024Dikluwe talk contribs 42,127 bytes +43 Created page with "Uma classe para armazenar uma coleção de coordenadas é definida em um arquivo de cabeçalho C++. A parte superior do arquivo é comentada, e algumas palavras-chave são usadas, como {{incode|@class}},{{incode|@brief}} e {{incode|@sa}} para indicar partes importantes. Dentro da classe, antes dos protótipos do método de classe, um bloco de texto comentado explica o que a função faz e seus argumentos. * Código fonte de [https://github.com/Kitware/VTK/blob/master/Com..."
  • curprev 16:3516:35, 19 June 2024Dikluwe talk contribs 42,084 bytes +31 Created page with "Este é um exemplo do [https://vtk.org/ VTK], uma biblioteca de visualização 3D usada para apresentar dados científicos, como resultados de elementos finitos e informações de nuvem de pontos."
  • curprev 16:3516:35, 19 June 2024Dikluwe talk contribs 42,053 bytes +42 Created page with "=== Exemplo do projeto VTK ==="
  • curprev 16:3416:34, 19 June 2024Dikluwe talk contribs 42,011 bytes +78 Created page with "Outro exemplo é o arquivo {{incode|src/Gui/Command.cpp}}. Antes dos detalhes de implementação {{incode|Gui::Command}} dos métodos, há um bloco de documentação que explica alguns detalhes da estrutura de comando do FreeCAD. Ele tem vários comandos {{incode|\section}} para estruturar a documentação. Ele ainda inclui código de exemplo incluído em um par de palavras-chave {{incode|\code}} e {{incode|\endcode}}; quando o arquivo é processado por Doxygen, este ex..."
  • curprev 16:2916:29, 19 June 2024Dikluwe talk contribs 41,933 bytes +14 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> Exemplo {{incode|src/Base/core-base.dox}}; este arquivo na árvore de código fonte do FreeCAD dá uma breve explicação do namespace {{incode|Base}}."
  • curprev 16:2816:28, 19 June 2024Dikluwe talk contribs 41,919 bytes −4 Created page with "O projeto FreeCAD adiciona vários arquivos terminandos em {{incode|.dox}}, a fim de fornecer uma descrição, ou exemplos, do código. É importante que esses arquivos sejam categorizados corretamente em um grupo ou namespace, para o qual o Doxygen fornece alguns comandos auxiliares como {{incode|\defgroup}}, {{incode|\ingroup}} e {{incode|\namespace}}."
  • curprev 16:2616:26, 19 June 2024Dikluwe talk contribs 41,923 bytes +39 Created page with "Essa maneira de documentar um arquivo de origem é útil se você quiser apenas adicionar documentação ao seu projeto sem adicionar código real. Quando você coloca um bloco de comentários em um arquivo com uma das seguintes extensões {{incode|.dox}}, {{incode|.txt}} ou {{incode|.doc}} então o Doxygen analisará os comentários e criará a documentação apropriada, mas ocultará esse arquivo auxiliar da lista de arquivos."
  • curprev 16:2416:24, 19 June 2024Dikluwe talk contribs 41,884 bytes +12 Created page with "Nesse caso, o comando estrutural {{incode|\file}} é usado para indicar qual arquivo de origem está sendo documentado; Um comando estrutural {{incode|\fn}} indica que o código a seguir é uma função, e o comando {{incode|\brief}} é usado para fornecer uma pequena descrição dessa função."
  • curprev 16:2316:23, 19 June 2024Dikluwe talk contribs 41,872 bytes +4 Created page with "Segundo arquivo, {{incode|source.h.dox}}:"
  • curprev 16:2216:22, 19 June 2024Dikluwe talk contribs 41,868 bytes +6 Created page with "Primeiro arquivo, {{incode|source.h}}:"
  • curprev 16:2216:22, 19 June 2024Dikluwe talk contribs 41,862 bytes +20 Created page with "Como alternativa, a documentação pode ser colocada em outro arquivo (ou no mesmo arquivo na parte superior ou inferior, ou onde), longe da declaração de classe ou protótipo de função. Nesse caso, você terá informações duplicadas, uma vez no arquivo de origem real e uma vez no arquivo de documentação."
  • curprev 16:2116:21, 19 June 2024Dikluwe talk contribs 41,842 bytes +74 Created page with "=== Segundo estilo: bloco de documentação em outro lugar ==="
  • curprev 16:2016:20, 19 June 2024Dikluwe talk contribs 41,768 bytes +8 Created page with "O bloco de documentação especial começa como um comentário no estilo C {{incode|→‎}}, mas tem um asterisco adicional {{incode|/**}}; O bloco termina com uma correspondência {{incode|: }}. Uma alternativa é usar comentários no estilo C++ com uma barra adicional {{incode|//}}."
  • curprev 16:1916:19, 19 June 2024Dikluwe talk contribs 41,760 bytes +31 Created page with "Normalmente, você deseja documentar o código no arquivo de cabeçalho, logo antes da declaração de classe ou do protótipo de função. Isso mantém a declaração e a documentação próximas uma da outra, por isso é fácil atualizar a última se a primeira for alterada."
  • curprev 16:1716:17, 19 June 2024Dikluwe talk contribs 41,729 bytes +77 Created page with "=== Primeiro estilo: bloco de documentação antes do código ==="
  • curprev 16:1716:17, 19 June 2024Dikluwe talk contribs 41,652 bytes +53 Created page with "Nota: * A vantagem da primeira opção é que você não precisa repetir o nome da entidade (função, membro, variável, classe ou namespace), pois o Doxygen analisará o código e extrairá as informações relevantes. * Os arquivos só podem ser documentados usando a segunda opção, já que não há como colocar um bloco de documentação antes de um arquivo. É claro que os membros do arquivo (functions, variables, typedefs, defines) não precisam de um comando est..."
  • curprev 15:0115:01, 19 June 2024Dikluwe talk contribs 41,599 bytes +2 No edit summary
  • curprev 15:0015:00, 19 June 2024Dikluwe talk contribs 41,597 bytes +177 Created page with "A seção Introdução (Etapa 3) do manual do Doxygen menciona as maneiras básicas de documentar as fontes. Para membros, classes e namespaces existem basicamente duas opções: Coloque um "bloco de documentação" especial (um parágrafo comentado) antes da declaração ou definição da função, membro, classe ou namespace. Para membros de arquivo, classe e namespace (variáveis) também é permitido colocar a documentação diretamente após o membro. Consulte a s..."
  • curprev 14:5814:58, 19 June 2024Dikluwe talk contribs 41,420 bytes −2 Created page with "A seção [http://www.doxygen.nl/manual/starting.html Introdução (Etapa 3)] do manual do Doxygen menciona as maneiras básicas de documentar as fontes."
  • curprev 14:5814:58, 19 June 2024Dikluwe talk contribs 41,422 bytes +43 Created page with "== Doxygen com código C++ =="
  • curprev 14:5714:57, 19 June 2024Dikluwe talk contribs 41,379 bytes +19 Created page with "{{Caption|Fluxo de trabalho geral para produzir documentações de código-fonte com o Doxygen.}}"
  • curprev 14:5614:56, 19 June 2024Dikluwe talk contribs 41,360 bytes +47 Created page with "Este documento dá uma breve introdução ao Doxygen, em particular como ele é usado no FreeCAD para documentar suas fontes. Visite a página de documentação de origem para obter instruções sobre como construir a documentação do FreeCAD, que também está hospedada on-line no site da [https://www.freecadweb.org/api/API do FreeCAD]."
(newest | oldest) View ( | ) (20 | 50 | 100 | 250 | 500)