scaladoc - Online na nuvem

PROGRAMA:

NOME

escalado - Gerador de documentação para a linguagem Scala 2

SINOPSE

escalado [opções>]fonte arquivos>

PARÂMETROS

<opções>
Opções de linha de comando. Ver OPÇÕES abaixo.

<fonte arquivos>
Um ou mais arquivos de origem a serem compilados (como MyClass.scala).

DESCRIÇÃO

O escalado ferramenta lê definições de classe e objeto, escritas na programação Scala 2
linguagem e gera sua API como arquivos HTML.

Por padrão, o gerador coloca cada arquivo HTML no mesmo diretório de seu arquivo de origem.
Você pode especificar um diretório de destino separado com -d (Vejo OPÇÕES, abaixo).

O formato reconhecido de comentários na fonte é descrito na documentação online

OPÇÕES

Standard Opções
-d <anuário>
Especifique onde gerar a documentação.

-versão
Imprima a versão do produto e saia.

-Socorro Imprima uma sinopse das opções disponíveis.

Documentação Opções
-doc-título <título>
Defina o título geral da documentação, normalmente o nome da biblioteca
sendo documentado.

-doc-versão <versão>
Defina o número da versão geral da documentação, normalmente a versão do
a biblioteca sendo documentada.

-doc-fonte-url <url>
Defina uma URL a ser concatenada com os locais de origem para vincular aos arquivos de origem.

-doc-externo-doc <documento externo>
Defina uma lista separada por vírgulas de pares classpath_entry_path # doc_URL que descrevem
dependências externas.

Compilador Opções
-verboso
Mensagens de saída sobre o que o compilador está fazendo

- depreciação
Indique se a fonte deve ser compilada com informações de reprovação; padrões
para desligado (os valores aceitos são: ligado, desligado, sim e não)

Disponível desde Scala versão 2.2.1

-caminho de classe <caminho>
Especifique onde encontrar arquivos de classe de usuário (em sistemas baseados em Unix separados por dois pontos
lista de caminhos, em sistemas baseados no Windows, uma lista de caminhos separada por ponto-e-vírgula). Esse
não substitui o caminho de pesquisa embutido ("inicialização").

O caminho de classe padrão é o diretório atual. Configurando a variável CLASSPATH ou
usar a opção de linha de comando -classpath substitui esse padrão, então se você quiser
incluir o diretório atual no caminho de pesquisa, você deve incluir "." no novo
configurações.

-caminho de origem <caminho>
Especifique onde encontrar os arquivos de origem de entrada.

-bootclasspath <caminho>
Substituir a localização dos arquivos de classe de bootstrap (onde encontrar o padrão embutido
classes, como "scala.List").

-extdirs <dirs>
Substitua a localização das extensões instaladas.

-codificação <codificação>
Especifique a codificação de caracteres usada pelos arquivos de origem.

O valor padrão é específico da plataforma (Linux: "UTF8", Windows: "Cp1252").
Executar o seguinte código no interpretador Scala retornará o valor padrão
no seu sistema:

scala> new java.io.InputStreamReader (System.in) .getEncoding

SAIR STATUS

escalado retorna um status de saída zero se for bem-sucedido no processamento da entrada especificada
arquivos. Diferente de zero é retornado em caso de falha.

AUTORES

Esta versão do Scaladoc foi escrita por Gilles Dubochet com contribuições de Pedro
Furlanetto e Johannes Rudolph. É baseado no Scaladoc original (Sean McDirmid,
Geoffrey Washburn, Vincent Cremet e St? Phane Micheloud), em vScaladoc (David Bernard),
bem como em uma versão inédita do Scaladoc 2 (Manohar Jonnalagedda).

Use scaladoc online usando serviços onworks.net