fpdoc-3.0.0 - Online na nuvem

PROGRAMA:

NOME

fpdoc - O gerador de documentação da unidade FPC Pascal.

SINOPSE

fpdoc --input = inputcommand [--output = output] [--format = fmt] [--descr = descriptionfile]
[--package = packagename] [opções]

Descrição

fpdoc varre um arquivo fonte da unidade Free Pascal e gera documentação para ele. o
a documentação pode estar em vários formatos (atualmente HTML e LaTeX) Ela pode ler vários
arquivos de descrição que contêm a descrição para os vários símbolos encontrados na unidade
arquivo.

Uso

Você pode invocar fpdoc com como o único argumento necessário a 'entrada' e 'pacote'
argumentos. Deve conter pelo menos o nome do arquivo da unidade para a qual a documentação
deve ser gerado e o nome do pacote ao qual a unidade pertence.

Opções

fpdoc tem várias opções, a maioria delas opcionais, os padrões serão usados ​​na maioria dos casos.

--contente
Esta opção diz fpdoc para gerar um arquivo de conteúdo. Um arquivo de conteúdo contém uma lista
de todas as âncoras (rótulos) possíveis no arquivo de documentação gerado, e pode
ser usado para criar ligações cruzadas na documentação para unidades diferentes, usando o
--importar opção.

--cputarget = value
Esta opção diz fpdoc para qual CPU gerar documentação. Isto simplesmente
define as macros apropriadas da CPU.

--descr = descfile
Esta opção especifica o nome de um arquivo de descrição arquivo desc que contém o
documentação real da unidade. Esta opção pode ser dada várias vezes, por
vários arquivos de descrição.

--descr-dir = dir
Esta opção especifica o nome de um diretório com arquivos de descrição XML, chamados dir
Esta opção pode ser fornecida várias vezes, para vários diretórios de descrição. Esse
opção é equivalente a especificar todos os arquivos no diretório com a opção --descr
opção.

--não apara
Esta opção diz ao fpdoc para não cortar os espaços em branco nos arquivos XML. Por padrão,
o espaço em branco é cortado da entrada, o que pode ter efeitos colaterais indesejáveis ​​em
por exemplo, tags PRE.

--funcionamento a seco
Esta opção diz fpdoc não para gerar nenhuma saída, mas apenas analisar todas as entradas. Esse
pode ser usado com a opção detalhada para verificar quais erros permanecem no
documentação, ou o que ainda está faltando.

--format = fmt
Especifica o formato fmt em que a documentação será gerada. Currenly,
os seguintes formatos são conhecidos:

chm CHM com nomes de arquivos em conformidade com 8.3, principalmente para janelas.

dxml Saída XML compatível com Delphi.

htm HTML com nomes de arquivo em conformidade com 8.3.

html HTML com nomes extensos de arquivos.

IPF Saída IPF (formato OS / 2, pode ser usado com docview do fpGUI).

xhtml XHTML com nomes de arquivos longos.

látex LaTex, que usa o estilo fpc.sty usado pela documentação do Free Pascal.

homem saída de página de manual (páginas de manual unix, uma página por identificador).

rtf Saída RTF.

txt Saída de texto simples.

estrutura xml
XML estruturado.

--Socorro Mostra um resumo das opções da linha de comando.

--ocultar-protegido
Por padrão, a documentação incluirá descrições e listas de produtos protegidos
campos e métodos em classes ou objetos. Esta opção muda este comportamento; Se isso
for especificado, nenhuma documentação será gerada para esses métodos. Observe que
métodos públicos ou propriedades que se referem a esses métodos protegidos terão, então, um
link pendente (isto é, indisponível).

--html-search = link
Adiciona uma entrada para uma página de pesquisa HTML no local link nos cabeçalhos do
páginas HTML geradas. Não há uma página de pesquisa fornecida, isso deve ser feito e
fornecido pelo usuário.

--import = impfile
importa um arquivo de conteúdo imparquivo de outro conjunto de documentação. Isso pode ser usado para
resolver referências a elementos neste outro arquivo de documentação;

--input = cmd
Esta opção diz fpdoc qual arquivo de entrada deve ser usado. O argumento cmd pode ser
apenas um nome de arquivo, mas também pode ser uma linha de comando completa do compilador com opções que
concernem a varredura da fonte pascal: define, inclui arquivos, opções de sintaxe,
pois seriam especificados para o compilador pascal livre ao compilar o arquivo. Se
um comando completo é usado, então ele deve ser colocado entre aspas simples ou duplas,
para que a casca não os parta em partes. É possível especificar vários
comandos de entrada; eles serão tratados um por um, e a documentação será
gerado para cada um deles.

--input-dir = dir
Esta opção diz fpdoc para adicionar todos os arquivos .pas e .pp no ​​diretório denominado cmd as
arquivos de entrada para o documentador. Isso é equivalente a especificar todos os arquivos no
diretório com o --entrada comando.

--lang = idioma
Define o idioma do arquivo de saída. Isso irá definir principalmente as strings usadas para
os cabeçalhos em várias partes dos arquivos de documentação (por padrão, eles estão em
inglês). Atualmente, as opções válidas são

de Alemão.

fr Francês.

nl Holandês.

--latex-extension = ext
Define a extensão a ser usada para o arquivo LaTeX para ext o padrão é .tex (com .
(ponto) incluído).

--latex-realce
Ativa um realce de sintaxe de látex interno. Isso ainda não foi implementado. Por
padrão, o realce de sintaxe é fornecido pelo pacote de sintaxe que vem com o fpc.

--mo-dir = dir
Esta opção diz fpdoc onde procurar os arquivos de tradução que podem ser usados ​​para
internacionalizar a saída do fpdoc.

--ostarget = value
Esta opção diz fpdoc para qual sistema operacional gerar documentação. Esse
simplesmente define as macros apropriadas do sistema operacional.

--output = nome
Esta opção diz fpdoc onde o arquivo de saída deve ser gerado. Como esta opção
é interpretado depende do formato que é usado. Para látex, nome é interpretado
como o nome do arquivo para o arquivo tex. Para todos os outros formatos, nome é interpretado como o
diretório onde todos os arquivos de documentação serão gravados. O diretório será
criado se ainda não existir. Padrão é igual ao nome do pacote.

--package = packagename
Especifica o nome do pacote. Todas as unidades serão documentadas como parte de nome do pacote ,
que também é o nome de arquivo ou diretório de saída padrão. Apenas nós de documentação
dentro de um nó de pacote com este nome será considerado durante a documentação.

--parse-impl
(Experimental) tente analisar a implementação de uma unidade também, isso pode ser usado para
verificação de sintaxe.

--project = arquivo
Esta opção diz fpdoc para ler todas as opções de um arquivo de projeto. Este é um XML
arquivo, consulte a documentação para obter mais informações sobre o formato para este
arquivo.

- show-private
Por padrão, nenhuma documentação é gerada para métodos ou campos privados. Esse
opção causa fpdoc para gerar documentação para esses métodos também.

--verbose
Por padrão, o fpdoc é esparso com saída. Isso diz ao fpdoc para gerar mais alguns
informações sobre o que está fazendo.

--warn-no-node
Se esta opção for especificada, fpdoc irá emitir um aviso se não encontrar um
nó de descrição para um identificador que está documentando.

--write-project = arquivo
Se esta opção for especificada, fpdoc irá escrever um arquivo de projeto fpdoc (para o
nome do arquivo especificado) que corresponde às opções de linha de comando fornecidas.

Use fpdoc-3.0.0 online usando serviços onworks.net