cxref - Online en la nube

PROGRAMA:

NOMBRE

cxref - Herramienta de documentación y referencias cruzadas en C.

SINOPSIS

cxref nombre de archivo [ ... nombre del archivo] [-Onombre de directorio] [-NORTEnombre base] [-Rnombre base] [-todos los comentarios]
[-sin comentarios] [-comentarios-textuales] [-bloque-comentarios]
[-xref [-todos] [- archivo] [- func] [- var] [- tipo]] [-advertir [-todos] [- comentario] [- xref]]
[-index [-todos] [- archivo] [- func] [- var] [- tipo]] [-crudo] [-látex] [-html [-src]] [-rtf] [-sgml]
[-YOnombre de directorio] [-Ddefinir] [-Udefinir] [-CPP cpp_programa] [- cpp_args ... cpp_args]

cxref nombre de archivo [ ... nombre del archivo] -borrar [-Onombre de directorio] [-NORTEnombre base] [-Rnombre base]

DESCRIPCIÓN

Un programa que puede generar automáticamente documentación y referencias cruzadas para un C
.

La entrada es cualquier programa en C con comentarios apropiados y la salida es LaTeX, HTML, RTF o
Archivos SGML.

CAMPUS

nombre de archivo
El nombre del archivo a documentar, se puede documentar cualquier número de archivos a la vez.

-borrar
Los archivos nombrados deben eliminarse del directorio de salida y sus entradas en
la base de datos de referencias cruzadas y los archivos de salida principales deben eliminarse.

-Odirnombre
El nombre de un directorio que se utilizará para los archivos latex de salida y la ubicación del
archivos de referencia cruzada que se crean.

-N nombre base
El nombre que se utilizará para la primera parte de la salida y los archivos de referencia cruzada en su lugar
de cxref, las extensiones de archivo siguen siendo las mismas.

-Rdirname
Cuando los archivos de origen se encuentran en más de un directorio, establezca dirname con el nombre de
el directorio raíz del árbol de origen (use la ruta relativa si es más fácil, por ejemplo, `-R ../ ..').
Esto luego ejecutará cxref desde ese directorio raíz y el `-Odirname 'debe ser
relativo a ese directorio.

-todos los comentarios
En caso de que crea que los comentarios existentes podrían funcionar (consulte la descripción anterior
de comentarios especiales). [¡Peligro! Esta opción puede producir resultados extraños.]

-sin comentarios
Ignora todos los comentarios, útil si solo desea las referencias cruzadas y no las
documentación.

-comentarios-textuales
Cuando los comentarios que tiene en el código están formateados en un estilo predeterminado
que desea conservar en la salida, esta opción los obligará a no ser
reformateado. [Tenga en cuenta que esto es solo para comentarios de archivos y funciones].

-bloque-comentarios
Cuando los comentarios en el programa están formateados en el estilo de `bloque '(con un encabezado
'*' en cada línea), esta opción eliminará ese carácter de la
producción. [Funciona para un solo `* ',` +', `| ' o ':' en cada línea.]

-refx Producir información de referencias cruzadas (ver más abajo).
-todos Todas las referencias cruzadas.
-archivo Referencias cruzadas para archivos.
-func Referencias cruzadas para funciones.
-var Referencias cruzadas para variables.
-tipo Referencias cruzadas para tipos.

-advertir Producir advertencias, las opciones deben concatenarse juntas:
-todos Todas las advertencias.
-comentar Advierte de comentarios faltantes.
-xref Advierte de la falta de referencias cruzadas.

-índice Producir un índice de referencia cruzada, las opciones deben concatenarse juntas:
-todos Todos los índices.
-archivo Índice de archivos.
-func Índice de funciones.
-var Índice de variables.
-tipo Índice de tipos.

-crudo Produce una forma de salida sin procesar, que no es realmente de mucha utilidad excepto con -warn.

-látex Produzca un archivo LaTeX para documentar cada uno de los archivos fuente y también un archivo adicional
que incluye cada uno de estos archivos.

-html Produzca un archivo HTML 4.01 para documentar cada uno de los archivos fuente y un archivo principal para
hacer referencia a cada uno de estos archivos.

-html-fuente
Genere la salida HTML y una versión HTML del archivo de origen con enlaces.

-rtf Produzca un archivo de formato de texto enriquecido (RTF) para documentar el archivo de origen.

-sgml Produzca un archivo SGML para documentar el archivo de origen. (Usando el DTD de LinuxDoc).

-Idirnombre
Opción GCC para especificar la ruta de los archivos de inclusión.

-Ddefinir
Opción GCC para definir un símbolo de preprocesador.

-Udefinir
Opción GCC para anular la definición de un símbolo de preprocesador.

-CPP programa
El nombre del programa que se utilizará en lugar del tiempo de compilación predeterminado. El programa
debe poder realizar todas las acciones que hace `gcc -E -C -dD 'para funcionar. Si
el programa toma argumentos, entonces todo debe estar entre comillas para que
se interpreta como un único argumento para cxref.

--arg ... arg
Los argumentos adicionales que se pasarán al preprocesador se pueden colocar después de '-'
separador.

C Compilador DE MOLARES cxref-cc
Para simplificar el uso de cxref en el código fuente existente, ahora hay un script de shell que
Llame al compilador de C y luego llame a cxref para procesar el archivo fuente. Esto significa que
se puede utilizar como reemplazo directo de CC en Makefiles y similares.

Uso: cxref-cc [opciones habituales de cc]

El nombre del archivo fuente se extrae de la lista de opciones, así como el '-D *',
`-I * ',` -U *' marca y cuando el compilador de C finaliza con éxito, se llamará a cxref. los
El nombre del compilador de C a utilizar está controlado por la variable de entorno CXREFCC, o si
esto no se establece entonces la variable de entorno CC, o en su defecto solo gcc.

El uso de este script requiere el uso de un archivo de configuración '.cxref' para contener las opciones
ya que no hay ningún lugar para poner las opciones en la línea de comando para el compilador de C.

Esto solo hará una referencia cruzada y documentará los archivos fuente de C, ya que son los únicos
los que están compilados, pero se asegurará de que tengan referencias cruzadas con los
opciones correctas, etc.

Cxref Configuración Archive
Estos argumentos de la línea de comandos también se pueden colocar en un archivo llamado `.cxref 'en lugar de en el
línea de comando. Cuando se ejecuta cxref, los argumentos del programa se interpretan en el
siguiente orden.

(1) Aquellos en la línea de comando. (2) Aquellos en el archivo '.cxref' en el directorio actual.
(3) Aquellos en el archivo '.cxref' en la raíz del árbol fuente especificado por '-R'.

Esto significa que en un árbol de fuentes de varios directorios, cada subdirectorio puede tener un `.cxref '
archivo que contiene solo la línea `-R .. 'o apropiado. El directorio principal puede tener un
Archivo `.cxref 'que contiene el resto de las opciones. Esto elimina completamente la necesidad
para tener opciones en la línea de comandos además de los nombres de los archivos de origen.

El formato del archivo '.cxref' es cualquier número de líneas, cada una contiene un único
argumento de línea de comando (equivalente a uno de los argv). Las únicas opciones que no pueden ser
se utilizan los nombres de los archivos fuente y la opción "-delete". Las líneas en blanco son
ignorado y las líneas que comienzan con un '#' son comentarios.

Programa Documentación Comentarios
La documentación del programa se produce a partir de comentarios en el código que son
con el formato adecuado. La referencia cruzada proviene del propio código y no requiere
trabajo extra.

Los comentarios especiales son `/ **** **** / '(para un archivo) y` / * ++++ ++++ * /' (para un archivo
objeto) se puede usar cualquier número de `* 'o` +' dentro del comentario estándar `/ * 'y` * /'
delimitadores en los comentarios, se ignoran.

Si una línea de comentario comienza con un espacio en blanco y va seguida de `+ html + ', entonces el resto del
La línea se incluye solo en la salida HTML y no se procesa, por lo que puede incluir HTML
marcado, `-html- 'significa que el resto de la línea se incluye en todos excepto en HTML
producción. Lo mismo se aplica también a los otros formatos de salida, se puede usar `+ none + 'para las líneas
no aparecer en ninguna salida. La excepción a esto es que la salida sin procesar no hace ningún
comprobando y dará salida a todas las líneas.

En cualquier situación en la que un comentario siga a un `, ',`;' o ')' separados solo por espacios y
pestañas, el comentario se coloca antes de la puntuación para aplicarlo al objeto allí.

El programa se implementa utilizando un analizador gramatical completo ANSI C con algunas extensiones GCC,
esto significa que el estilo del código no es importante, solo el contenido y los comentarios.

Cruz Referenciando
La referencia cruzada se realiza para los siguientes elementos

archivos
Los archivos en los que se incluye el archivo actual
(incluso cuando se incluye a través de otros archivos).

#incluye
Archivos incluidos en el archivo actual.
Archivos incluidos por estos archivos, etc.

Variables
La ubicación de la definición de variables externas.
Los archivos que tienen visibilidad de variables globales.
Los archivos / funciones que usan la variable.

Clave
El archivo en el que se crea el prototipo de la función.
Las funciones a las que llama la función.
Las funciones que llaman a la función.
Los archivos y funciones que hacen referencia a la función.
Las variables que se utilizan en la función.

Cada uno de estos elementos tiene referencias cruzadas en el resultado.

La referencia cruzada utiliza archivos `cxref.variable ',` cxref.function', `cxref.include 'y
`cxref.typedef 'en el directorio de salida. Éstos son una lista completa de la función y
uso variable en el programa y podría usarse para generar una jerarquía de llamadas de función o
diagrama de uso variable, por ejemplo. Se necesitan dos pasadas cxref de cada archivo, la primera en
construir los archivos de referencias cruzadas y el segundo para usarlos.

(Los nombres de archivo son diferentes si se usa la opción `-N ').

Látex Salida
La salida LaTeX predeterminada es un archivo para cada uno de los archivos de origen con un archivo adicional
`cxref.tex 'que incluye cada uno de los otros archivos. Esto es para permitir que un archivo MAKE solo
actualizar los archivos modificados (aunque las referencias pueden requerir que todos los archivos sean
comprobado de nuevo). Cuando se ha escrito el archivo cxref.tex, el usuario puede modificarlo,
los archivos nuevos que se agregan se agregan al final de la sección de código fuente, el resto de
el archivo no se modifica.

El índice se escribe en un archivo llamado `cxref.apdx.tex 'y cxref.tex se actualiza para hacer referencia
a la misma.

También están escritos tres archivos de estilo LaTeX `page.sty ',` fonts.sty' y `cxref.sty '.
Estos configuran la página para usar un margen más pequeño y fuentes más pequeñas para permitir que aparezcan más en
una página y también definir los nuevos comandos para la composición tipográfica de la salida cxref.

(Los nombres de archivo `cxref.tex 'y` cxref.apdx.tex' son diferentes si la opción `-N 'es
usó.)

HTML Salida
La salida HTML predeterminada es un archivo para cada uno de los archivos de origen con un archivo adicional
`cxref.html 'que incluye cada uno de los otros archivos. Esto es para permitir que un archivo MAKE solo
actualizar los archivos modificados (aunque las referencias pueden requerir que todos los archivos sean
comprobado de nuevo). Cuando se ha escrito el archivo cxref.html, el usuario puede modificarlo,
los archivos nuevos que se agregan se agregan al final antes de la tabla de contenido, el resto
del archivo sin cambios.

El índice se escribe en un archivo llamado `cxref.apdx.html 'y cxref.html se actualiza para hacer referencia
a la misma.

(Los nombres de archivo `cxref.html 'y` cxref.apdx.html' son diferentes si la opción `-N 'es
usó.)

La salida HTML utiliza el estándar HTML 4.01 y todas las páginas se validan correctamente.

RTF Salida
El formato de texto enriquecido es un formato de descripción de página de nivel bastante bajo ideado por Microsoft. Eso
no es un estándar bien definido y fácil de entender como lo son los otros formatos, pero es
popular para el intercambio de documentos.

Hay un solo archivo de salida para cada uno de los archivos de origen y un archivo de índice.

SGML Salida
Dado que SGML es un metalenguaje, es necesario definir los elementos de diseño, así como
proporcionar la información. La salida cxref usa el formato de documento LinuxDoc y es
diseñado para su uso con los programas SGMLtools (http://www.sgmltools.org/).

Hay un solo archivo de salida para cada uno de los archivos de origen y un archivo de índice.

Utilice cxref en línea utilizando los servicios de onworks.net