arinca - Online na nuvem

PROGRAMA:

NOME

haddock - ferramenta de documentação para código-fonte Haskell anotado

SINOPSE

eglefim [opções] lima...

DESCRIÇÃO

Esta página de manual documenta resumidamente o eglefim comando. A documentação extensa é
disponível em vários outros formatos, incluindo DVI, PostScript e HTML; Veja abaixo.

lima é um nome de arquivo contendo um módulo fonte Haskell. Todos os módulos especificados no
linha de comando será processada junto. Quando um módulo se refere a uma entidade em outro
módulo sendo processado, a documentação será vinculada diretamente a essa entidade.

Entidades que não podem ser encontradas, por exemplo porque estão em um módulo que não está sendo
processado como parte do lote atual, simplesmente não terá um hiperlink na
documentação. eglefim irá emitir avisos listando todos os identificadores que não pode
resolver.

Os módulos não devem ser recursivos mutuamente, pois eglefim não gosta de nadar
círculos.

OPÇÕES

Os programas seguem a sintaxe de linha de comando GNU usual, com longas opções começando com dois
travessões (`- '). Um resumo das opções está incluído abaixo. Para uma descrição completa, veja
a outra documentação.

-o DIR, --odir =DIR
diretório no qual colocar os arquivos de saída

-i ARQUIVO, --read-interface =ARQUIVO
ler uma interface de ARQUIVO.

-D ARQUIVO, --dump-interface =ARQUIVO
despejar uma interface para esses módulos em ARQUIVO.

-l DIR, --lib =DIR
localização dos arquivos auxiliares de Haddock

-h, --html
Gere documentação em formato HTML. Vários arquivos serão gerados no
diretório atual (ou o diretório especificado se o -o opção é fornecida), incluindo
o seguinte:

index.html
A página de nível superior da documentação: lista os módulos disponíveis, usando
recuo para representar a hierarquia se os módulos forem hierárquicos.

arinca.css
A folha de estilo usada pelo HTML gerado. Sinta-se à vontade para modificar isso para
mude as cores ou layout, ou até mesmo especifique sua própria folha de estilo usando o
--css opção.

modulo.html
Uma página HTML para cada módulo.

doc-index.html, doc-index-XX.html
O índice, dividido em dois (funções / construtores e tipos / classes, conforme
Namespaces Haskell) e posteriormente divididos em ordem alfabética.

--hoogle
saída para Hoogle

--html-help =formato
produz o índice e a tabela de conteúdo no formato mshelp, mshelp2 ou devhelp (com -h)

--source-base =URL
Incluir links para os arquivos de origem na documentação gerada, onde URL é o
URL base onde os arquivos de origem podem ser encontrados.

-s Url, --source-module =URL
Incluir links para os arquivos de origem na documentação gerada, onde URL é um
link do código-fonte para cada módulo (usando as variáveis% {FILE} ou% {MODULE}).

--source-entity =URL
Incluir links para os arquivos de origem na documentação gerada, onde URL é um
link do código-fonte para cada entidade (usando as variáveis% {FILE},% {MODULE} ou% {NAME}).

--comments-base =URL
URL para um link de comentários nas páginas de conteúdo e índice.

--comments-module =URL
URL para um link de comentários para cada módulo (usando a var% {MODULE}).

--comments-entity =URL
URL para um link de comentários para cada entidade (usando o% {FILE},% {MODULE} ou% {NAME}
var).

--css =ARQUIVO
Use o CSS ARQUIVO em vez da folha de estilo padrão que vem com eglefim para HTML
saída. Deve especificar certas classes: consulte a folha de estilo padrão para obter detalhes.

-p ARQUIVO, --prologue =ARQUIVO
Especifique um arquivo que contém o texto do prólogo.

-t IMERSÃO DE INGLÊS, --title =IMERSÃO DE INGLÊS
Use IMERSÃO DE INGLÊS como o título da página para cada página da documentação. Isso vai
normalmente é o nome da biblioteca que está sendo documentada.

O título deve ser uma string simples (sem marcação, por favor!).

-k NOME, --package =NOME
Especifique o nome do pacote (opcional).

-n, --no-implícito-prelúdio
não assuma que o Prelude é importado

-d, --depurar
Habilite a saída de depuração extra.

-?, --Socorro
Exibir ajuda.

-V, --versão
Versão de exibição.

-v, --verbose
Relatórios de status detalhados.

--use-contents =URL
Use uma página de conteúdo HTML gerada separadamente.

--gen-contents
Gere um conteúdo HTML a partir de interfaces especificadas.

--use-index =URL
Use um índice HTML gerado separadamente.

--gen-index
Gere um índice HTML a partir de interfaces especificadas.

--ignore-all-exportações
Comporte-se como se todos os módulos tivessem o atributo ignore-exports

--hide =MÓDULO
Comporte-se como se MÓDULO tem o atributo ocultar.

--use-package =PACKAGE
Os módulos que estão sendo processados ​​dependem de PACKAGE.

Use haddock online usando serviços onworks.net