Skip to content

Home

Jump to bottom
Alejandro Linarez Rangel edited this page Feb 18, 2017 · 1 revision

Bienvenidos/as a la wiki de pdhelpextracter, la suite de documentación de PseudoD >2.2.0!

Instalando

Copia pdhelpextracter.pl, pdhelpextracter-autosearch.sh y docmypd.pl a un lugar donde puedan ser llamados facilmente como:

pdhelpextracter.pl ejemplo.pseudo ClaseDeEjemplo

Uso

pdhelpextracter.pl

Extrae en línea la documentación de un archivo. Este archivo donde se buscará es el primer argumento, el segundo argumento es lo que se desea buscar.

Ejemplos

# Nuevas versiones de PseudoD
pdhelpextracter.pl /opt/pseudod/bepd/tipos.pseudo "PoseeMetodo" | less

# Viejas versiones de PseudoD (obsoleto)
pdhelpextracter.pl /usr/lib/pseudod/2.1.0/tipos.pseudo "Referencia" | less

# Otros:
pdhelpextracter.pl miproyecto/include/pd/aplicacion.pseudo "Gtk#Aplicacion" | less
pdhelpextracter.pl $PSEUDODPATH/plugins/entsal/entsal.pseudo "Archivo" | less

pdhelpextracter-autosearch.sh

Extrae en línea la documentación. Busca en PSEUDODPATH y en /opt/pseudod/bepd/ por algún archivo que contenga documentación acerca de su único argumento.

Ejemplos

pdhelpextracter-autosearch.sh "Arreglo" | less
pdhelpextracter-autosearch.sh "Objeto" | less
pdhelpextracter-autosearch.sh "CSTD" | less
pdhelpextracter-autosearch.sh "Fraccion#sumar" | less

docmypd.pl

Extrae todos los comentarios de documentación de un archivo y escribe en la salida estándar el resultado de exportar dicha documentación a HTML. Su único argumento es el archivo a exportar.

Nota: El resultado no es HTML-válido. No posee <head> ni <html> o una especificación de caracteres <meta charset="..." />. Es muy recomendable editar estos archivos antes de su uso.

Ejemplos

docmypd.pl $PSEUDODPATH/builtins.pseudo > builtins.doc.html
docmypd.pl miarchivo.pseudo > miarchivo.html

También puede declarar plantillas como en pddoc:

==== header.html ====
<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>Ejemplo</title>
    </head>
    <body>
==== footer.html ====
    </body>
</html>
==== export.sh ====
cat header.html > archivo.html
docmypd.pl archivo.pseudo >> archivo.html
cat footer.html >> archivo.html
Clone this wiki locally