mdoc-update - Online na nuvem

PROGRAMA:

NOME

atualização mdoc - mdoc(5) suporte de formato de documentação

SINOPSE

mdoc atualizar [OPÇÕES] * CONJUNTOS

DESCRIÇÃO

mdoc atualizar é responsável pelo seguinte:

* Criação de stubs de documentação com base em CONJUNTOS. O processo de criação de stub irá
criar novo mdoc(5) arquivos XML para cada tipo dentro CONJUNTOSe forneça
stubs de documentação para cada membro desses tipos.

* Atualizar stubs de documentação com base em CONJUNTOS. Existir mdoc(5) a documentação pode
ser atualizado para refletir as mudanças dentro CONJUNTOS, como tipos e membros adicionados,
preservando a documentação existente.

Em algumas circunstâncias limitadas, as renomeações serão rastreadas, minimizando o
carga de documentação quando, por exemplo, um parâmetro é renomeado.

mdoc atualizar não depende da documentação encontrada no código-fonte, embora possa importar
Comentários da documentação XML por meio do -i opção.

See mdoc(1) e mdoc(5) para mais informações.

OPÇÕES

--excluir
Permitir mdoc atualizar para excluir membros dos arquivos de documentação. Os únicos membros
excluídos são membros que não estão mais presentes em CONJUNTOS e não são
presente em qualquer outra versão do assembly.

Se um tipo não estiver mais presente, o arquivo de documentação é não excluído, mas é
em vez disso renomeado ter um .retirar extensão.

A detecção de versão é feita com o // AssemblyVersion elementos; se não houver
// AssemblyVersion elementos para um dado or , Em seguida, o será
renomeado e / ou o será removido.

- exceções[=FONTES]
EXPERIMENTAL. Isso não é 100% confiável, mas tem como objetivo servir como um auxílio para
escritores de documentação.

Inspecione os corpos dos membros para determinar quais exceções podem ser geradas a partir do
membro.

FONTES é uma lista opcional separada por vírgulas das seguintes fontes que devem ser
procurou exceções:

adicionado apenas gerar elementos para membros
adicionado durante a execução do programa atual.
Isso evita que o mdoc-update re-gerando
elementos para todos os membros (e, portanto,
impede a reinserção de membros que tiveram o
elementos removidos).
todos Encontrar exceções criadas no próprio membro,
referências a membros na mesma assembléia,
e referências a membros dependentes
assembléias.
asm Encontrar exceções criadas no próprio membro e
referências a membros dentro da mesma assembleia
como o membro.
depasm Encontre exceções criadas no próprio membro e
referências a membros dentro de dependentes
assembléias.

If FONTES não é fornecido (o padrão), apenas exceções criadas dentro do
o próprio membro será documentado.

LIMITAÇÕES: A pesquisa de exceção é atualmente implementada procurando pelo
tipos de exceção que são criados explicitamente com base nos tipos de tempo de compilação conhecidos.
Isso tem as seguintes limitações:

* Isso não encontrará exceções implícitas ao IL, como
NullReferenceException e IndexOutOfRangeException.

* Isso encontrará exceções que são não jogado, por exemplo

public void CreateAnException()
{
Exceção e = nova Exceção ();
}

* Isso não "seguirá" chamadas de delegado e interface:

public void UsaDelegates()
{
Func a = x => {lançar uma nova exceção ();};
um (4);
}

A função UsesDelegates () não terá exceções documentadas.

* Isso encontrará exceções que "não podem acontecer", como
ArgumentNullExceptions para argumentos "conhecidos" como não nulos:

vazio público A ()
{
B ("este parâmetro não é nulo");
}

vazio público B (string s)
{
se (s == null)
lance novo ArgumentNullException ("s");
}

Para o acima, se --exceptions = asm é fornecido então UMA() será documentado
como lançando uma ArgumentNullException, que não pode acontecer.

-f=FLAG
Especifique um sinalizador para alterar o comportamento. Sinalizadores válidos incluem:

versões sem montagem
veja a -fno-assembly-versões documentação, abaixo.

-fno-assembly-versões
Não gere / Type / AssemblyInfo / AssemblyVersion e
/ Tipo / Membros / Membro / AssemblyInfo elementos.

Isso é útil para evitar "rotatividade" durante as atualizações. Normalmente, se um tipo ou membro
não mudou, mas a versão da montagem mudou, então todos os tipos e membros
será atualizado para incluir um novo // AssemblyVersion elemento, aumentando assim o
quantidade de mudanças que precisam ser revisadas antes de serem confirmadas (assumindo que todas as mudanças são
realmente revisado antes do commit).

AVISO: Este precisarão interagir mal com o --excluir opção, como --excluir utiliza o
// AssemblyVersion elementos para rastrear mudanças de versão. Assim, se você tem um membro
que está presente em uma versão de montagem anterior e é removido em um subsequente
versão de montagem, como System.Text.UTF8Encoding.GetBytes (string) (qual é
presente no .NET 1.0, mas não no .NET 2.0), o membro será removido quando o
--excluir -fno-assembly-versões opções são especificadas, o membro estava presente em um
versão anterior do conjunto, e a versão atual do conjunto não
conter o membro.

Consequentemente, esta opção deve só ser especificado se os tipos e membros forem nunca
ser removido de uma montagem.

-i, --importar=ARQUIVO
Documentação de importação encontrada em ARQUIVO.

ARQUIVO pode conter qualquer um csc / doc XML ou ECMA-335 XML.

-L, --lib=DIRETÓRIO
Adicionar DIRETÓRIO para o caminho de pesquisa do assembly, de modo que as dependências de CONJUNTOS pode
ser encontrado sem documentar essas montagens.

-o, --Fora=DIRETÓRIO
Coloque os stubs gerados em DIRETÓRIO.

Ao atualizar a documentação, DIRETÓRIO também é o diretório de origem.

-r=MONTAGEM
MONTAGEM é uma dependência para um de CONJUNTOS qual deveria não ser documentado, mas
é necessário para processar um dos CONJUNTOS. Adicione o diretório que contém MONTAGEM para
o caminho de pesquisa da montagem.

Esta opção é equivalente a especificar -L `Conte-me MONTAGEM ».

--Desde a=VERSÃO
Quando atualização documentação para uma montagem, se um tipo ou membro for encontrado
que não existia na versão anterior da montagem a <desde
versão = "VERSÃO"/> elemento será inserido.

--modelo=TIPO
Atualize apenas a documentação para o tipo TIPO.

-h, - ?, --Socorro
Exiba uma mensagem de ajuda e saia.

Use mdoc-update online usando serviços onworks.net