PDL :: DOC PDL :: DOC proporciona soporte para la documentación en línea de PDL.
Descargar ahora

PDL :: DOC Clasificación y resumen

PDL :: DOC Etiquetas

Módulo perl documentación manual Pdl Documentación PDL Manual de PDL

PDL :: DOC Descripción

PDL :: DOC proporciona soporte para la documentación en línea de PDL. PDL :: DOC proporciona soporte para la documentación en línea de PDL.Synopsis Use PDL :: DOC; $ onlinedc = nuevo PDL :: DOC ($ DOCFILE); @match = $ onlinedc-> búsqueda ('m / slice | gump /'); Una implementación de documentos en línea para las convenciones de documentación PDL.PDL para un paquete como PDL que tiene muchas funciones, es muy deseable tener alguna forma de en línea Ayude a facilitar al usuario recordar los nombres, llamar a las convenciones y el uso típico de la multitud de funciones a su disposición. Para que sea sencillo extraiga la información relevante de la documentación de la POD en los archivos de origen que conforman la distribución de PDL, se han adoptado ciertos convenios en el formateo de esta documentación. La primera convención dice que toda la documentación de las funciones de PDL aparece en la sección POD introducida por = Head1 FunctionsIndIndIndividual Funciones individuales En esta sección, se introducen por = Head2 FuncnameWhere Firma es la lista de argumentos para una función definida por PP como se explica en PDL :: PP. En general, la documentación de PDL está en formato POD válido (consulte Perlpod) pero utiliza la = para la Directiva de una manera especial. La Directiva = para la Directiva se usa para marcar al analizador PDL POD que la información está siguiendo que se utilizará para generar ayuda en línea. El PDL PODPARSER se deriva de la clase PDL :: POD :: Parser Clase que tenía que ser parcheada en algunos lugares , en parte para corregir errores menores, en parte para mejorar la funcionalidad para el perusal por PDL :: DOC. Dado que el módulo PDL :: DOC aún es experimental, la distribución de POD-POD-POD-PODSER se incluye con la distribución actual de PDL-DOC. Tenga en cuenta que PDL :: DOC no funcionará correctamente con la distribución de POD-PODERSER lanzada. El analizador PDL POD reconoce lo siguiente = para las directivas: reforzar a que la referencia de una línea para esta función sigue, por ejemplo, = para ref Ref devuelve un Piddle of Lags a los padres. La firma para la función actual sigue, por ejemplo, = para la firma SIG: (A (N), B (), Uso de TMP (N)): una indicación de las posibles convenciones de llamadas para el Función actual, por ejemplo, = para uso WPIC ($ PDL, $ FILENAME ) Opciones de optlists para la función actual, por ejemplo, = para las opciones convertidor => 'ppmtogif', # explícitamente especifique las banderas del convertidor PBM => '-interLaced -Transparent 0', # banderas para convertidor iform => 'pgm', # explícitamente especifique el formato intermedio xtraflags => '-imagename iris', # banderas adicionales a defaultflags format => 'pcx', # explícitamente especifique Formato de imagen de salida Color => 'bw', # especifique la conversión de color lut => $ lut, # Use información de la tabla de coloresExample: da ejemplos de uso típico para el Cu Función de Rrent: =, por ejemplo, WPIC $ PDL, $ File; $ im-> wpic ('web.gif', {lut => $ lut}); para (@Images) {$ _-> WPIC ($ nombre , {convertidor => 'ppmtogif'})} BadProvides Información sobre cómo la función maneja los valores incorrectos (si $ PDL: config {with_badval} se establece en 1 ). La intención es tener esta información creada automáticamente para las funciones compiladas por PP, aunque puede ser excesiva. Requisitos: · Perl

PDL :: DOC Software relacionado