cxref - On-line na nuvem

PROGRAMA:

NOME

cxref - Ferramenta C de referência cruzada e documentação.

SINOPSE

cxref nome do arquivo [ ... nome do arquivo] [-OConte-me] [-Nnome de base] [-Rnome de base] [-todos-comentários]
[-sem comentários] [-comentários literais] [-bloco-comentários]
[-xref [-all] [- arquivo] [- func] [- var] [- tipo]] [-avisar[-todos][-comentário][-xref]]
[-index[-all][-file][-func][-var][-type]] [-cru] [-látex] [-html[-src]] [-rtf] [-sgml]
[-EUConte-me] [-Ddefinir] [-VOCÊdefinir] [-CPP cpp_program] [- cpp_args ... cpp_args]

cxref nome do arquivo [ ... nome do arquivo] -excluir [-OConte-me] [-Nnome de base] [-Rnome de base]

DESCRIÇÃO

Um programa que pode gerar automaticamente documentação e referências cruzadas para um C
.

A entrada é qualquer programa C com comentários apropriados e a saída é LaTeX, HTML, RTF ou
Arquivos SGML.

OPÇÕES

nome do arquivo
O nome do arquivo a ser documentado, qualquer número de arquivos pode ser documentado ao mesmo tempo.

-excluir
Os arquivos nomeados devem ser excluídos do diretório de saída e suas entradas em
o banco de dados de referência cruzada e os principais arquivos de saída devem ser removidos.

-Odirnome
O nome de um diretório a ser usado para os arquivos latex de saída e a localização do
arquivos de referência cruzada que são criados.

-Nome da base
O nome a ser usado para a primeira parte dos arquivos de saída e referência cruzada
do cxref, as extensões dos arquivos permanecem as mesmas.

-Rdirnome
Quando os arquivos de origem estiverem em mais de um diretório, defina dirname como o nome de
o diretório raiz da árvore de origem (use o caminho relativo se for mais fácil, por exemplo, `-R../ ..').
Isto irá então executar o cxref a partir desse diretório raiz e o `-Odirname' deve ser
relativo a esse diretório.

-todos os comentários
Caso você ache que os comentários existentes podem funcionar (veja acima a descrição
de comentários especiais). [Perigo! Esta opção pode produzir resultados estranhos.]

-sem comentários
Ignora todos os comentários, útil se você quiser apenas as referências cruzadas e não as
documentação.

-comentários literais
Quando os comentários que você tem no código são formatados em um estilo pré-determinado
que você deseja preservar na saída, esta opção irá forçá-los a não serem
reformatado. [Observe que isso é apenas para comentários de arquivos e funções.]

-bloco-comentários
Quando os comentários no programa são formatados no estilo `bloco' (com um início
caractere '*' em cada linha), esta opção removerá esse caractere do
saída. [Funciona para um único `*', `+', `|' ou `:' em cada linha.]

- refex Produza informações de referência cruzada (veja abaixo).
-all Todas as referências cruzadas.
-file Referências cruzadas para arquivos.
-func Referências cruzadas para funções.
-var Referências cruzadas para variáveis.
-tipo Referências cruzadas para tipos.

-avisar Produza avisos, as opções devem ser concatenadas:
-all Todos os avisos.
-comment Avisa sobre comentários ausentes.
-xref Avisa sobre referências cruzadas ausentes.

-índice Produza um índice de referência cruzada, as opções devem ser concatenadas:
-all Todos os índices.
-file Índice de arquivos.
-func Índice de funções.
-var Índice de variáveis.
-type Índice de tipos.

-cru Produza uma forma bruta de saída, que não tem muita utilidade, exceto com -warn.

-látex Produza um arquivo LaTeX para documentar cada um dos arquivos fonte e também um arquivo extra
que inclui cada um desses arquivos.

-html Produza um arquivo HTML 4.01 para documentar cada um dos arquivos de origem e um arquivo principal para
faça referência a cada um desses arquivos.

-html-src
Produza a saída HTML e uma versão HTML do arquivo de origem com links para ele.

-rtf Produza um arquivo Rich Text Format (RTF) para documentar o arquivo de origem.

-sgml Produza um arquivo SGML para documentar o arquivo de origem. (Usando o LinuxDoc DTD).

-Idirnome
Opção GCC para especificar o caminho para arquivos incluídos.

-Define
Opção GCC para definir um símbolo de pré-processador.

-Udefine
Opção GCC para indefinir um símbolo de pré-processador.

-CPP programa
O nome do programa a ser usado em vez do padrão de tempo de compilação. O programa
deve ser capaz de executar todas as ações que `gcc -E -C -dD' faz para funcionar. Se
o programa recebe argumentos, então tudo precisa estar entre aspas para que
é interpretado como um único argumento para cxref.

--arg ... arg
Argumentos extras a serem passados ​​ao pré-processador podem ser colocados após o `--'
separador.

C Compilador Substituição cxref-cc
Para simplificar o uso de cxref no código-fonte existente, existe agora um script de shell que irá
chame o compilador C e depois chame cxref para processar o arquivo de origem. Isto significa que
pode ser usado como um substituto para CC em Makefiles e similares.

Uso: cxref-cc [opções usuais de cc]

O nome do arquivo fonte é extraído da lista de opções, assim como o `-D*',
`-I*', `-U*' sinalizadores e quando o compilador C terminar com sucesso, cxref será chamado. O
O nome do compilador C a ser usado é controlado pela variável de ambiente CXREFCC ou, se
isso não está definido, então a variável de ambiente CC, ou na falta disso, apenas gcc.

O uso deste script requer o uso de um arquivo de configuração `.cxref' para conter as opções
já que não há lugar para colocar as opções na linha de comando do compilador C.

Isso apenas cruzará e documentará os arquivos de origem C, uma vez que eles são os únicos
aqueles que são compilados, mas garantirá que eles sejam cruzados com o
opções corretas etc.

Cxref Configuração Envie o
Esses argumentos de linha de comando também podem ser colocados em um arquivo chamado `.cxref' em vez de no
linha de comando. Quando cxref é executado, os argumentos do programa são interpretados no
seguinte ordem.

(1) Aqueles na linha de comando. (2) Aqueles no arquivo `.cxref' no diretório atual.
(3) Aqueles no arquivo `.cxref' na raiz da árvore de origem especificada por `-R'.

Isso significa que em uma árvore de origem com vários diretórios, cada subdiretório pode ter um `.cxref'
arquivo contendo apenas a linha `-R..' ou apropriado. O diretório principal pode ter um
Arquivo `.cxref' contendo o restante das opções. Isto elimina completamente a necessidade
para ter quaisquer opções na linha de comando além dos nomes dos arquivos de origem.

O formato do arquivo `.cxref' é qualquer número de linhas, cada uma contendo um único
argumento de linha de comando (equivalente a um dos argv). As únicas opções que não podem ser
usados ​​são os nomes dos próprios arquivos de origem e a opção `-delete'. As linhas em branco são
ignorados e as linhas que começam com '#' são comentários.

Agenda Documentação Comentários
A documentação do programa é produzida a partir de comentários no código que são
formatado adequadamente. A referência cruzada vem do próprio código e não requer
trabalho extra.

Os comentários especiais são `/**** ****/' (para um arquivo) e `/*++++ ++++*/' (para um arquivo de dados).
objeto) qualquer número de `*' ou `+' pode ser usado dentro do comentário padrão `/*' e `*/'
delimitadores nos comentários, eles serão ignorados.

Se uma linha de comentário começar com um espaço em branco e for seguida por `+html+' então o resto do
linha é incluída apenas na saída HTML e não é processada para poder incluir HTML
marcação, `-html-' significa que o resto da linha está incluído em todos, exceto no HTML
saída. O mesmo também se aplica aos outros formatos de saída, `+none+' pode ser usado para linhas
não aparecer em nenhuma saída. A exceção a isso é que a saída bruta não faz nenhuma
verificando e produzirá todas as linhas.

Em qualquer situação onde um comentário segue um `,', `;' ou `)' separados apenas por espaços e
guias, o comentário é colocado antes da pontuação para ser aplicado ao objeto ali.

O programa é implementado usando um analisador gramatical ANSI C completo com algumas extensões GCC,
isso significa que o estilo do código não é importante, apenas o conteúdo e os comentários.

Atravessar Referenciando
A referência cruzada é realizada para os seguintes itens

Arquivos
Os arquivos nos quais o arquivo atual está incluído
(mesmo quando incluído através de outros arquivos).

#inclui
Arquivos incluídos no arquivo atual.
Arquivos incluídos por esses arquivos etc.

Variáveis
A localização da definição de variáveis ​​externas.
Os arquivos que têm visibilidade de variáveis ​​globais.
Os arquivos/funções que usam a variável.

Funções
O arquivo no qual a função é prototipada.
As funções que a função chama.
As funções que chamam a função.
Os arquivos e funções que fazem referência à função.
As variáveis ​​que são usadas na função.

Cada um desses itens é referenciado na saída.

A referência cruzada usa os arquivos `cxref.variable', `cxref.function', `cxref.include' e
`cxref.typedef' no diretório de saída. Esta é uma lista completa da função e
uso variável no programa e pode ser usado para gerar uma hierarquia de chamada de função ou
diagrama de uso variável, por exemplo. São necessárias duas passagens cxref de cada arquivo, a primeira para
construir os arquivos de referência cruzada e o segundo para usá-los.

(Os nomes dos arquivos são diferentes se a opção `-N' for usada.)

Látex saída
A saída padrão do LaTeX é um arquivo para cada um dos arquivos de origem com um arquivo extra
`cxref.tex' que inclui cada um dos outros arquivos. Isto é para permitir que um makefile apenas
atualizar os arquivos alterados (embora as referências possam exigir que todos os arquivos sejam
verificado novamente). Quando o arquivo cxref.tex for gravado, ele poderá ser modificado pelo usuário,
quaisquer novos arquivos adicionados são adicionados no final da seção do código-fonte, o restante
o arquivo permanece inalterado.

O índice é gravado em um arquivo chamado `cxref.apdx.tex' e cxref.tex é atualizado para se referir
a ele.

Também estão escritos três arquivos de estilo LaTeX `page.sty', `fonts.sty' e `cxref.sty'.
Eles configuram a página para usar uma margem menor e fontes menores para permitir que mais informações apareçam
uma página e também definir os novos comandos para composição da saída cxref.

(Os nomes dos arquivos `cxref.tex' e `cxref.apdx.tex' são diferentes se a opção `-N' for
usava.)

HTML saída
A saída HTML padrão é um arquivo para cada um dos arquivos de origem com um arquivo extra
`cxref.html' que inclui cada um dos outros arquivos. Isto é para permitir que um makefile apenas
atualizar os arquivos alterados (embora as referências possam exigir que todos os arquivos sejam
verificado novamente). Quando o arquivo cxref.html for gravado, ele poderá ser modificado pelo usuário,
quaisquer novos arquivos adicionados são adicionados no final, antes do índice, o restante
do arquivo permanecendo inalterado.

O índice é gravado em um arquivo chamado `cxref.apdx.html' e cxref.html é atualizado para se referir
a ele.

(Os nomes dos arquivos `cxref.html' e `cxref.apdx.html' são diferentes se a opção `-N' for
usava.)

A saída HTML usa o padrão HTML 4.01 e todas as páginas são validadas corretamente.

RTF saída
Rich Text Format é um formato de descrição de página de nível bastante baixo desenvolvido pela Microsoft. Isto
não é um padrão bem definido e fácil de entender como são os outros formatos, mas é
popular para troca de documentos.

Há um único arquivo de saída para cada um dos arquivos de origem e um arquivo de índice.

SGML saída
Como SGML é uma metalinguagem é necessário definir os elementos do layout, bem como
forneça as informações. A saída cxref usa o formato de documento LinuxDoc e é
projetado para uso com os programas SGMLtools (http://www.sgmltools.org/).

Há um único arquivo de saída para cada um dos arquivos de origem e um arquivo de índice.

Use cxref online usando serviços onworks.net