mdassembler - Online na nuvem

PROGRAMA:

NOME

mdassembler - Compila a documentação para uso no navegador monodoc

SINOPSE

mdassembler OPÇÕES * DIRS +

DESCRIÇÃO

mdassembler tornou-se obsoleto por mdoc(1). Veja o montagem mdoc(1) página de manual.

mdassembler é um programa que cria .árvore e .zip arquivos para uso no monodoc
navegador de documentação.

O .árvore e .zip os arquivos são copiados para o monodoc's fontes diretório e residem em um
.fonte arquivo que é usado por monodoc para especificar onde a documentação deve estar
exibido. o .fonte arquivos / monodoc / source / @ basefile atributo especifica o nome do arquivo
prefixo para os arquivos de documentação. Deve ser o mesmo prefixo usado com o --Fora
parâmetro.

OPÇÕES

--ecma A documentação encontrada em DIRS está no formato de documentação Mono ECMA. Ver
da Mono ECMA Documentação Formato seção abaixo.

--ecmaspec
A documentação encontrada em DIRS está na documentação de especificação ECMA
formato. Veja o Mono ECMA Especificação Documentação Formato seção abaixo.

--erro
A documentação encontrada em DIRS está em formato de "erro". Veja o erro
Documentação Formato seção abaixo.

--Socorro Mostra a informação do argumento do programa.

--cara A documentação encontrada em DIRS está no formato de página de manual. Veja o Homem Página
Documentação Formato seção abaixo.

-ó, --Fora PREFIXO
Especifique o prefixo do arquivo de saída. mdassembler cria os arquivos PREFIXO.zip e
PREFIX.árvore .

--simples
A documentação encontrada em DIRS está em formato "simples". Veja o simples
Documentação Formato seção abaixo.

--xhtml, --hb
A documentação encontrada em DIRS está no formato XHTML. Veja o XHTML
Documentação Formato seção abaixo.

FORMATOS

Os seguintes formatos de documentação são suportados:

Mono ECMA Documentação Formato
Um formato de documentação XML com um arquivo por tipo.

veja a mdoc(5) página de manual para obter mais informações.

Mono ECMA Especificação Documentação Formato
Este não é o formato que você está procurando.

Este é o formato usado para representar o padrão ECMA-334 (C #) dentro monodoc. Não é
usado para exibir a documentação da biblioteca de classes; para documentação da biblioteca de classes, use o
--ecma formato.

erro Documentação Formato
Usado para apresentar mensagens de erro detalhadas e é usado em monodoc's "Erro do compilador C #
Árvore de "referência. DIRS não é um diretório, mas sim um arquivo de configuração, contendo
o XML:


../../mcs/errors
cs ???? *. cs
2
4
CS {0: 0 ###}


/ ErrorProviderConfig / FilesPath especifica onde procurar por arquivos,
/ ErrorProviderConfig / Match especifica o padrão de nome de arquivo a ser procurado
/ ErrorProviderConfig / FilesPath, / ErrorProviderConfig / ErrorNumSubstringStart e
/ ErrorProviderConfig / ErrorNumSubstringLength controlar qual parte do nome do arquivo é usada
como o número do erro, e / ErrorProviderConfig / FriendlyFormatString controla como o
formatação / exibição do nó no monodoc árvore.

Para cada arquivo encontrado, ele é convertido para HTML com coloração de sintaxe C # aplicada.

simples Documentação Formato
Converte arquivos de texto em HTML, traduzindo cada nova linha em um HTML elemento.

Homem Página Documentação Formato
Converte as páginas do manual em HTML para exibição.

XHTML Documentação Formato
Copia o arquivo XHTML no estado em que se encontra.

EXEMPLOS

Para instalar sua documentação para uso com monodoc:

Crie a PREFIX.origem lima
com o conteúdo:






onde FORMAT é o formato de documentação contido no PREFIX.árvore arquivo,
por exemplo, ecma, ou simples. PREFIXO is da nome de base of da .árvore e .zip arquivos que
mdassembler cria. PATH é o "caminho" na árvore monodoc que deve conter
a documentação. Veja o @ prefix @ / lib / monodoc / monodoc.xml arquivo para uma lista de
Valores de PATH (o // nó / @ nome valores).

Veja também: http://www.mono-
project.com/docs/tools+libraries/tools/monodoc/generating-documentation/

Crie sua documentação
Veja também o monodocente(1) página de manual, por exemplo

monodocer -assembly: foo.dll -path: foo / en

Montar da documentação

mdassembler --ecma foo / en PREFIXO

Certifique-se de usar o mesmo PREFIXO aqui como você fez acima.

Instale da documentação by utilização da comando

cp PREFIX.fonte PREFIX.tree PREFIX.zip \
`pkg-config monodoc --variable = sourcesdir`

(Observe os backticks usados ​​no pacote-config comando!) Isso copia o .fonte ,
.árvore e .zip arquivos no monodoc fontes diretório, o que permitirá monodoc
para exibir a documentação.

Use mdassembler online usando serviços onworks.net