ocamldoc - Online en la nube

PROGRAMA:

NOMBRE

ocamldoc - El generador de documentación OCaml

SINOPSIS

ocamldoc [ opciones ] nombre de archivo ...

DESCRIPCIÓN

El generador de documentación OCaml ocamldoc(1) genera documentación de especial
comentarios incrustados en archivos fuente. Los comentarios utilizados por ocamldoc son de la forma (** ...
*) y siga el formato descrito en el El proyecto OCaml usuario manual.

ocamldoc puede producir documentación en varios formatos: HTML, LaTeX, TeXinfo, Unix man
páginas, y punto(1) gráficos de dependencia. Además, los usuarios pueden agregar sus propios generadores personalizados.

En esta página de manual, usamos la palabra elementos para hacer referencia a cualquiera de las siguientes partes de un
Archivo fuente OCaml: una declaración de tipo, un valor, un módulo, una excepción, un tipo de módulo, un
constructor de tipos, un campo de registro, una clase, un tipo de clase, un método de clase, un valor de clase o
una cláusula de herencia de clase.

OPCIONES

Las siguientes opciones de la línea de comandos determinan el formato de la documentación generada
generado por ocamldoc(1).

Opciones for la elección de de la forma más salida formato
-html Genere documentación en formato HTML predeterminado. Las páginas HTML generadas se almacenan
en el directorio actual, o en el directorio especificado con el -d opción. Usted puede
personalizar el estilo de las páginas generadas editando el style.css archivo,
o proporcionando su propia hoja de estilo usando la opción -estilo css. El archivo style.css
no se genera si ya existe.

-látex Genera documentación en formato predeterminado de LaTeX. El documento LaTeX generado es
guardado en archivo ocamldoc.out, o en el archivo especificado con el -o opción. La
el documento usa el archivo de estilo ocamldoc.sty. Este archivo se genera cuando se utiliza el
-látex opción, si aún no existe. Puede cambiar este archivo para personalizarlo
el estilo de su documentación LaTeX.

-texi Genera documentación en el formato predeterminado de TeXinfo. El documento LaTeX generado es
guardado en archivo ocamldoc.out, o en el archivo especificado con el -o .

-hombre Genere documentación como un conjunto de páginas de manual de Unix. Las páginas generadas se almacenan
en el directorio actual, o en el directorio especificado con el -d .

-punto Genere un gráfico de dependencia para los módulos de nivel superior, en un formato adecuado para
visualización y procesamiento por punto(1). los punto(1) la herramienta está disponible en
http://www.research.att.com/sw/tools/graphviz/. La representación textual del
el gráfico se escribe en el archivo ocamldoc.out, o al archivo especificado con el -o
opción. Usar punto ocamldoc.out para mostrarlo.

-g presentar
Cargue dinámicamente el archivo dado (cuya extensión suele ser .cmo o .cma), que
define un generador de documentación personalizado. Si el archivo dado es simple y
no existe en el directorio actual, entonces ocamldoc lo busca en la costumbre
directorio predeterminado de los generadores, y en los directorios especificados con el -i .

-dir personalizado
Muestra el directorio predeterminado de generadores personalizados.

-i directorio
Agregue el directorio dado a la ruta donde buscar generadores personalizados.

General opciones
-d dir Generar archivos en directorio dir, en lugar del directorio actual.

-tugurio presentar
Volcar la información recopilada en presentar. Esta información se puede leer con el -carga
opción en una invocación posterior de ocamldoc(1).

-esconder módulos
Oculte los nombres completos de los módulos dados en la documentación generada. módulos es un
La lista de nombres de módulos completos está separada por comas (,), sin espacios en blanco. Para
ejemplo: Pervasivas, M2.M3.

-inv-merge-ml-mli
Invertir la precedencia de implementaciones e interfaces al fusionar. Todos
Los elementos de los archivos de implementación se guardan y -m La opción indica qué partes
de los comentarios en los archivos de interfaz se fusionan con los comentarios en la implementación
archivos.

-mantener-codigo
Conserve siempre el código fuente de los valores, métodos y variables de instancia, cuando
disponible. El código fuente siempre se conserva cuando se proporciona un archivo .ml, pero es por
se descarta por defecto cuando se proporciona un .mli. Esta opción permite que el código fuente sea
siempre guardado.

-carga presentar
Cargar información de presentar, que ha sido producido por ocamldoc -tugurio. Varios
-carga se pueden dar opciones.

-m banderas
Especifique opciones de combinación entre interfaces e implementaciones. banderas puede ser uno o
varios de los siguientes personajes:

d fusionar descripción

a fusionar @author

v fusionar @version

l fusionar @ver

s fusionar @since

o fusionar @deprecated

p fusionar @param

e fusionar @raise

r fusionar @return

A fusionar todo

-no-etiquetas-personalizadas
No permita etiquetas @ personalizadas.

-no te detengas
Mantenga los elementos colocados después de la (** / **) comentario especial.

-o presentar
Envíe la documentación generada a presentar en lugar de ocamldoc.out. Esta opcion es
significativo sólo en conjunción con el -látex, -texio -punto .

-páginas comando
Canalizar fuentes a través del preprocesador comando.

-ppx comando
Canalice el árbol de sintaxis abstracta a través del preprocesador comando.

-clasificar Ordene la lista de módulos de nivel superior antes de generar la documentación.

-estrellas Elimine los caracteres en blanco hasta el primer asterisco ('*') en cada línea de comentarios.

-t título
Usa título como título de la documentación generada.

-introducción presentar
Usar contenido de presentar as ocamldoc texto para usar como introducción (HTML, LaTeX y
Solo TeXinfo). Para HTML, el archivo se utiliza para crear el archivo "index.html" completo.

-v Modo detallado. Muestra información de progreso.

-versión
Imprime la cadena de la versión y sal.

-vnum Imprima el número de versión corto y salga.

-advertir-error
Tratar ocamldoc advertencias como errores.

-Ocultar-advertencias
No imprimir ocamldoc advertencias

-ayuda or --ayuda
Muestre un breve resumen de uso y salga.

Verificación de tipo opciones
ocamldoc(1) llama al verificador de tipo OCaml para obtener información sobre el tipo. Las siguientes opciones
impactar la fase de verificación de tipo. Tienen el mismo significado que para el
ocamlc(1) y ocamlopt(1) comandos.

-I directorio
Añadir el archivo directorio a la lista de directorios, busque archivos de interfaz compilados (.cmi
archivos).

-noetiquetas
Ignore las etiquetas no opcionales en los tipos.

-rectipos
Permitir tipos recursivos arbitrarios. (Ver el -rectipos opción de ocamlc(1).)

Opciones for la generación de HTML paginas
Las siguientes opciones se aplican junto con el -html opción:

-todos-params
Muestra la lista completa de parámetros para funciones y métodos.

-estilo css nombre de archivo
Usa nombre de archivo como el archivo de hoja de estilo en cascada.

-código para colorear
Colorea el código OCaml entre [] y \ {[] \}, usando colores para enfatizar
palabras clave, etc. Si los fragmentos de código no son sintácticamente correctos, no se muestra ningún color
añadido.

-sólo índice
Genere solo archivos de índice.

-corto-functores
Utilice una forma corta para mostrar los functores: módulo M : funtor (A: módulo) -> funtor
(B: Módulo2) -> sig .. final se muestra como módulo M (A: módulo) (B: Módulo2) : sig ..
final.

Opciones for la generación de Látex archivos
Las siguientes opciones se aplican junto con el -látex opción:

-prefijo-valor-látex prefijo
Dé un prefijo para usar en las etiquetas de los valores en el documento LaTeX generado.
El prefijo predeterminado es la cadena vacía. También puedes usar las opciones -tipo-látex-
prefijo, -prefijo-excepción-látex, -prefijo-módulo-látex, -prefijo-de-tipo-módulo-látex,
-prefijo-clase-látex, -prefijo-tipo-clase-látex, -prefijo-atributo-látexy -látex-
prefijo-método.

Estas opciones son útiles cuando tiene, por ejemplo, un tipo y un valor con la
mismo nombre. Si no especifica prefijos, LaTeX se quejará de multiplicar
etiquetas definidas.

-título de látex n, estilo
Número de estilo asociado n al comando de seccionamiento de LaTeX dado style, p.ej
.orsubsección. (Solo LaTeX). Esto es útil cuando se incluyen los
documento en otro documento LaTeX, en un nivel de sección dado. El valor por defecto
La asociación es 1 para la sección, 2 para la subsección, 3 para la subsección, 4 para
párrafo y 5 para el subpárrafo.

-no encabezado
Suprime el encabezado en la documentación generada.

-notoc No genere una tabla de contenido.

-notrailer
Suprime el tráiler en la documentación generada.

-sepfiles
Genere un archivo .tex por módulo de nivel superior, en lugar del global ocamldoc.out
archivo.

Opciones for la generación de TeXinfo archivos
Las siguientes opciones se aplican junto con el -texi opción:

-esc8 Escapa de los caracteres acentuados en los archivos de información.

-entrada de información
Especifique la entrada del directorio de información.

-info-sección
Especifique la sección del directorio de información.

-no encabezado
Suprime el encabezado en la documentación generada.

-noíndice
No cree índices para archivos de información.

-notrailer
Suprime el tráiler en la documentación generada.

Opciones for la generación de punto gráficos
Las siguientes opciones se aplican junto con el -punto opción:

-colores-de-puntos colores
Especifique los colores que se utilizarán en el código de puntos generado. Al generar módulo
dependencias, ocamldoc(1) utiliza diferentes colores para los módulos, dependiendo de la
directorios en los que residen. Al generar dependencias de tipos, ocamldoc(1)
utiliza diferentes colores para los tipos, dependiendo de los módulos en los que están
definido. colores es una lista de nombres de colores separados por comas (,), como en
Rojo, azul, verde. Los colores disponibles son los admitidos por el punto(1) herramienta.

-punto-incluir-todo
Incluya todos los módulos en el punto(1) salida, no solo módulos dados en el comando
línea o cargado con el -carga .

-punto-reducir
Realice una reducción transitiva del gráfico de dependencia antes de generar el punto
código. Esto puede ser útil si hay muchas dependencias transitivas que se desordenan
la gráfica.

-tipos de puntos
Código de punto de salida que describe el gráfico de dependencia de tipos en lugar del módulo
gráfico de dependencia.

Opciones for la generación de hombre archivos
Las siguientes opciones se aplican junto con el -hombre opción:

-hombre-mini
Genere páginas de manual solo para módulos, tipos de módulos, clases y tipos de clases, en su lugar
de páginas para todos los elementos.

-man-sufijo sufijo
Establezca el sufijo utilizado para los nombres de archivo man generados. El valor predeterminado es o, como en Lista.o.

-sección-hombre .
Establezca el número de sección utilizado para los nombres de archivo man generados. El valor predeterminado es 3.

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