Opções da linha de comando

Enviado por Yukare em terça-feira, 8 de Agosto de 2017 - 15:06

Importante: escrevi toda esta documentação há um tempo atrás para a versão 1.4.3 do phpDocumentor. No entanto agora existe a versão 2. Acredito que quase tudo escrito aqui se aplica também a versão 2, mas ainda preciso revisar todo este conteúdo para corrigir qualquer eventual diferença.

Esta é uma lista das opções em linha de comando aceitas pelo phpdoc, várias destas opções podem ter mais de um argumento como nomes de arquivos e diretórios, neste caso são separados por "," (vírgula).

-c --config

Faz com que seja utilizado um arquivo de configuração. Vou explicar mais sobre isso em outra pagina, para mim essa é a melhor maneira de usar do que ficar especificando a cada vez as opções que eu quero.

-cp --converterparams

Define dinamicamente parâmetros para um conversor, separe os valores com virgulas

-ct --customtags

Uma lista separada por virgula de @tags que não sejam padrões para passar para o conversor como válidas(quando você adiciona suas próprias tags)

-d     --directory  

Nome do diretório(s) a serem interpretados

-dc     --defaultcategoryname  

Nome da categoria padrão, se não for especificado usa 'default'

-dh     --hidden

Define como on (-dh on) para que diretórios ocultos também sejam interpretados (diretórios que começam com "."), o padrão é off (diretórios ocultos não serão interpretados).

-dn     --defaultpackagename

Nome do pacote padrão, se não for especificado será usado 'default'

-ed     --examplesdir

Caminho completo do diretório onde procurar os arquivos de exemplo das tags @example.

-f     --filename

Nome dos arquivos a interpretar. Pode ser um caminho completo e pode se utilizar os coringas * e ?.

-i     --ignore

Arquivos que serão ignorados. Pode se utilizar os coringas * e ?. Ideal para usar quando sua aplicação usa bibliotecas externas para as quais você não quer que toda a documentação dela faça parte da sua.

-is     --ignoresymlinks

Explicitamente ignora os links simbólicos(espécie de atalho para um arquivo/diretório no sistema de arquivo usado em Linux). As opções válidas são "on" e "off", o valor padrão é "off"

-it     --ignore-tags

Tags que devem ser ignoradas nesta interpretação. @package, @subpackage, @access e @ignore não devem ser ignoradas.

-j     --javadocdesc

Usar a descrição de modo compatível com JavaDoc.

-o     --output

Formato de saída, format:converter:template (por exemplo HTML:frames:phpedit)

-p     --pear

Interpreta um repositório no estilo PEAR(pacote é o diretório, membros tem @access private) on/off, o padrão é off

-po     --packageoutput

Cria documentação apenas para os pacotes selecionados, use uma lista separada por vírgula

-pp     --parseprivate

Interpreta os elementos marcados como private com @access. As opções válidas são "on" e "off", o valor padrão é "off"

-q     --quiet

Não exibe as mensagens de interpretação/conversão. Útil para trabalhos cron. Opções válidas são "on" e "off". O valor padrão é off.

-ric     --readmeinstallchangelog

Especifica nomes de arquivos personalizados para interpretar como README, INSTALL ou CHANGELOG. O conteúdo dele é adicionado na documentação sem nenhuma modificação..

-s     --sourcecode

Gera o código fonte com modo de destaque de cores para todos os arquivos interpretados (PHP 4.3.0 ou posterior apenas). Com isso todo o código fonte da sua aplicação fica disponível na documentação. Opções válidas são "on" e "off". Padrão é "off".

-t     --target

Caminho aonde os arquivos gerados devem ser salvos

-ti     --title

Titulo da documentação gerada, o padrão é "Generated Documentation". Recomendo que você especifique um.

-tb     --templatebase

Caminho base para todos os templates nesta interpretação. Note que se -tb /path/to/here, então o template para HTML:frames:default deve estar em /path/to/here/Converters/HTML/frames/templates/default/templates e o diretório /path/to/here/Converters/HTML/frames/templates/default/templates_c directory deve existir, ou o Smarty irá falhar na tentativa de compilar os templates. A menos que você tenha alguma necessidade bem especifica, nunca irá utilizar esta opção.

-ue     --undocumentedelements

Ativa avisos para elementos não documentados. Útil para identificar classes e métodos que ainda não tenham sido documentados. Opções válidas são "on" e "off". O valor padrão é "off". Recomendo que deixe esta opção como on enquanto tiver escrevendo a documentação.