fpdoc-3.0.0: en línea en la nube

PROGRAMA:

NOMBRE

fpdoc: el generador de documentación de la unidad FPC Pascal.

SINOPSIS

fpdoc --input = inputcommand [--output = output] [--format = fmt] [--descr = descriptionfile]
[--package = packagename] [opciones]

Descripción

fpdoc escanea un archivo fuente de unidad de Free Pascal y genera documentación para él. los
La documentación puede estar en varios formatos (actualmente HTML y LaTeX) Puede leer varios
archivos de descripción que contienen la descripción de los diversos símbolos que se encuentran en la unidad
archivo.

Uso

Puedes invocar fpdoc con como único argumento requerido la 'entrada' y el 'paquete'
argumentos. Debe contener al menos el nombre del archivo de unidad para el cual la documentación
debe generarse y el nombre del paquete al que pertenece la unidad.

De Seguros

fpdoc tiene varias opciones, la mayoría de ellas opcionales, en la mayoría de los casos se utilizarán los valores predeterminados.

--contenido
Esta opción dice fpdoc para generar un archivo de contenido. Un archivo de contenido contiene una lista
de todos los anclajes posibles (etiquetas) en el archivo de documentación generado, y puede
ser utilizado para crear enlaces cruzados en la documentación para diferentes unidades, utilizando el
--importar .

--cputarget = valor
Esta opción dice fpdoc para qué CPU generar documentación. Esto simplemente
define las macros de CPU adecuadas.

--descr = archivo desc
Esta opción especifica el nombre de un archivo de descripción descarchivo que contiene el
documentación actual de la unidad. Esta opción se puede dar varias veces, por
varios archivos de descripción.

--descr-dir = dir
Esta opción especifica el nombre de un directorio con archivos de descripción XML, llamado dir
Esta opción se puede dar varias veces, para varios directorios de descripción. Esta
La opción es equivalente a especificar todos los archivos en el directorio con --descr
.

--no recortar
Esta opción le dice a fpdoc que no recorte los espacios en blanco en los archivos XML. Por defecto,
los espacios en blanco se recortan de la entrada, lo que puede tener efectos secundarios indeseables en
por ejemplo, etiquetas PRE.

- corrida en seco
Esta opción dice fpdoc no para generar ninguna salida, sino simplemente analizar toda la entrada. Esta
se puede utilizar con la opción verbose para comprobar qué errores quedan en el
documentación, o lo que aún falta.

--format = fmt
Especifica el formato fmt en el que se generará la documentación. Actualmente,
se conocen los siguientes formatos:

chm CHM con nombres de archivo compatibles con 8.3, principalmente para Windows.

dxml Salida XML compatible con Delphi.

htm HTML con nombres de archivo compatibles con 8.3.

html HTML con nombres de archivo largos.

ipf Salida IPF (formato OS / 2, se puede utilizar con docview desde fpGUI).

xhtml XHTML con nombres de archivo largos.

látex LaTex, que usa el estilo fpc.sty usado por la documentación de Free Pascal.

hombre Salida de página de manual (páginas de manual de Unix, una página por identificador).

rtf Salida RTF.

txt Salida de texto sin formato.

estructura xml
XML estructurado.

--ayuda Muestra un resumen de opciones de la línea de comandos.

--protegido contra la piel
De forma predeterminada, la documentación incluirá descripciones y listados de
campos y métodos en clases u objetos. Esta opción cambia este comportamiento; si se
se especifica, no se generará documentación para estos métodos. Tenga en cuenta que
Los métodos o propiedades públicos que se refieren a estos métodos protegidos tendrán entonces un
enlace colgante (es decir, no disponible).

--html-search = enlace
Agrega una entrada para una página de búsqueda HTML en la ubicación enlace en los encabezados de la
páginas HTML generadas. No se proporciona una página de búsqueda, esto debe hacerse y
proporcionada por el usuario.

--import = impfile
importa un archivo de contenido archivo impulsivo de otro conjunto de documentación. Esto se puede utilizar para
resolver referencias a elementos dentro de este otro archivo de documentación;

--input = cmd
Esta opción dice fpdoc qué archivo de entrada se debe utilizar. El argumento cmd puede ser
solo un nombre de archivo, pero también puede ser una línea de comandos completa del compilador con opciones que
se refieren al escaneo de la fuente pascal: define, incluye archivos, opciones de sintaxis,
ya que se especificarían en el compilador de Free Pascal al compilar el archivo. Si
se utiliza un comando completo, luego debe incluirse entre comillas simples o dobles,
para que la cáscara no los rompa en partes. Es posible especificar varios
comandos de entrada; serán tratados uno a uno, y la documentación será
generado para cada uno de ellos.

--input-dir = dir
Esta opción dice fpdoc para agregar todos los archivos .pas y .pp en el directorio llamado cmd as
archivos de entrada al documentalista. Esto equivale a especificar todos los archivos en el
directorio con el --aporte mando.

--lang = idioma
Establece el idioma del archivo de salida. Esto establecerá principalmente las cadenas utilizadas para
los encabezados en varias partes de los archivos de documentación (por defecto están en
inglés). Actualmente, las opciones válidas son

de Alemán.

fr Francés.

nl Holandés.

--latex-extensión = ext
Establece la extensión que se utilizará para el archivo LaTeX en ext el valor predeterminado es .tex (con .
(punto) incluido).

- resaltado de látex
Activa un resaltador de sintaxis de látex interno. Esto aún no está implementado. Por
Por defecto, el resaltado de sintaxis lo proporciona el paquete de sintaxis que viene con fpc.

--mo-dir = dir
Esta opción dice fpdoc dónde buscar los archivos de traducción que se pueden utilizar para
internacionalizar la salida de fpdoc.

--ostarget = valor
Esta opción dice fpdoc para qué sistema operativo generar documentación. Esta
simplemente define las macros apropiadas del sistema operativo.

--output = nombre
Esta opción dice fpdoc donde se debe generar el archivo de salida. ¿Cómo esta opción
se interpreta depende del formato que se utilice. Para el látex, nombre se interpreta
como nombre de archivo para el archivo tex. Para todos los demás formatos, nombre se interpreta como el
directorio donde se escribirán todos los archivos de documentación. El directorio será
creado si aún no existe. Estándar esto es igual al nombre del paquete.

--package = nombre del paquete
Especifica el nombre del paquete. Todas las unidades se documentarán como parte de Nombre del paquete ,
que también es el nombre de archivo o directorio de salida predeterminado. Solo nodos de documentación
dentro de un nodo de paquete con este nombre se considerará al documentar.

--parse-impl
(Experimental) intente analizar la implementación de una unidad también, esto se puede usar para
comprobación de sintaxis.

--proyecto = archivo
Esta opción dice fpdoc para leer todas las opciones de un archivo de proyecto. Este es un XML
archivo, consulte la documentación para obtener más información sobre el formato de este
archivo.

- show-privado
De forma predeterminada, no se genera documentación para métodos o campos privados. Esta
causas de la opción fpdoc para generar documentación para estos métodos también.

--verboso
De forma predeterminada, fpdoc es escasa con salida. Esto le dice a fpdoc que genere más
información sobre lo que está haciendo.

--advertir-no-nodo
Si se especifica esta opción, fpdoc Emitirá una advertencia si no encuentra un
nodo de descripción para un identificador que está documentando.

--escribir-proyecto = archivo
Si se especifica esta opción, fpdoc escribirá un archivo de proyecto fpdoc (en el
nombre de archivo especificado) que corresponde a las opciones de línea de comandos proporcionadas.

Use fpdoc-3.0.0 en línea usando los servicios de onworks.net