Manual de instalación y buenas prácticas
Contents
1. Bajo l nea de comandos para usuarios m s avanzados Con interfaz gr fica en modo de asistente USO DE DOXYGEN BAJO L NEA DE COMANDOS En el proceso de instalaci n Doxygen ha modificado la variable de entorno PATH de modo que desde cualquier directorio podemos ejecutar la orden doxygen Para arrancarlo basta con abrir una ventana de int rprete de rdenes Inicio gt Ejecutar gt cmd E A ates C Users JuanCar los gt Si ejecutamos doxygen sin ningun par metro ste mostrar por pantalla la sintaxis de uso 004 DOXYGEN Co Users JuanCarlos doxygqen Doxyfile not found and no input file specified Doxygen version 1 7 5 1 Copyright Dimitri van Heesch 1997 2611 You can use doxygen in a number of ways 1 gt Use doxygen to generate a template configuration file doxygen s g configName If is used for configName doxygen will write to standard output Use doxygen to update an old configuration file doxygen s u configName Use doxygen to generate documentation using an existing configuration file doxygen conf ig Hame If is used for configName doxygen will read from standard input Use doxygen to generate a template file controlling the layout of the generated documentation doxygen 1 layoutFileName xml Use doxygen to generate a template style sheet file for RIF HTML or Latex RIF doxygen w rtf styleSheetFile HTML doxygen w html headerFile footerFile styleSheetFile con2. Next http rw doxygen or There are three mailing lists doxygen usersilists sourceforge net For doxygen users doxygen develop lists sourceforge net For doxygen developers doxygen announce Glists sourceforge net Announcement of new releases only please follow the link in http sourceforge net projects doxygen to subscribe to the lists or to visit the archives Use the bug tracker to report bugs Una vez finalizada la instalaci n se mostrar una ventana como en la figura anterior en ella aparece informacion acerca de los enlaces de descarga e informacion sobre Doxygen listas de correo para los desarrolladores y usuarios de Doxygen e informacion para el reporte de errores Para continuar pulsamos Next A continuaci n aparece una ventana como la siguiente indicando que la instalaci n se ha realizado con exito 004 DOXYGEN Setup doxygen 5 Setup doxyg Completing the doxygen Setup Wizard Setup has finished installing doxygen on your computer The application may be launched by selecting the installed icons Click Finish to exit Setup Pulsamos Finish para cerrar la ventana Tras todos estos pasos hemos instalado Doxygen en nuestro equipo Para acceder al men de instalaci n hemos de acceder al men de programas de Windows do doxygen Doxygen documentation HTML de Examples Folder a Uninstall doxygen Google Chrome Le Inicio de Juegos Mantenimiento Microsoft Off
3. Step 2 Configure doxygen using the Wizard and or Expert tab then switch to the Run tab to generate the documentation Use dot tool from the GraphViz package Dot graphs to generate Collaboration diagrams Overall Class hierarchy Y Indude dependency graphs Induded by dependency graphs Y Call graphs W Called by graphs Opciones establecidas en la pantalla anterior CLASS_DIAGRAMS YES HAVE_DOT YES CLASS GRAFH YES COLLABORATION_GRAPH YES INCLUDE_GRAPH Mo INCLUDED_BY_GRAPH YES CALL_GRAPH YES CALLER_GRAPH YES GRAPHICAL HIERARCHY YES 21 004 DOS CAN Step 1 Specify the working directory from which doxygen will run C Users JuanCarlos Step 2 Configure doxygen using the Wizard and or Expert tab then switch to the Run tab to generate the documentation Build Messages Input Source Browser Index HTML LaTex Man PROJECT_NAME The PROJECT _NAME tag is a single word or sequence of words that should identify the Project Note that if you do not use Doxywizard you need to put quotes around the project name if it contains spaces The name class The name widget The name file Previous Opciones establecidas en la pantalla anterior OUTPUT_LANGUAGE Spanish Ejemplos de pantallas del resultado obtenido en formato HTML 004 Portfolio 004 Pagina principal Paquetes Clases Archivos Q7 Buscar Lista de clases ndice de clases Jerarqu a de la clase Miembros de las
4. clases Lista de clases Lista de las clases estructuras uniones e interfaces con una breve descripci n es us isg2 trivial Casilla es us isg2 trivial CasillaDado es us isg2 trivial CasillaPregunta es us isg2 trivial CasillaQueso es us isg2 trivial CasilllaCentral es us isg2 trivial Dado es us isg2 database JDBCFacade es us isg2 trivial Jugador es us isg2 trivial Main es us isg2 trivial Pregunta es us isg2 database JDBCFacade ResultSetiterator es us isg2 trivial Tablero es us isg2 trivial TableroFabrica es us isg2 trivial TipoDePregunta es us isg2 trivial Trivial Generado el S bado 5 de Noviembre de 2011 11 21 24 para 004 por do AY AN 1 7 5 1 22 004 DO CAN 004 Portfolio 004 Pagina principal Paquetes Archivos Qr Buscar Lista de clases Indice de clases Jerarquia de la clase Miembros de las clases Indice de clases CIDIJIMIPIRIT CasilllaCentral Jugador TableroFabrica es us isg2 trivial es us isg2 trivial es us isg2 trivial c TipoDePregunta es us isg2 trivial Casilla es us isg2 trivial JDBCFacade ResultSetIterator Trivial es us isg2 trivial O es us isg2 database CasillaDado es us isg2 trivial Dado es us isg2 trivial Main es us isg2 trivial CasillaPregunta T es us isg2 trivial CasillaQueso Tablero es us isg2 trivial JDBCFacade Pregunta es us isg2 database es us isg2 trivial es us isg2 trivial CIDIJIMIPIRIT Generado el S bado 5 de Noviembre de
5. de configuraci n a establecer Concretamente son 16 subdivisiones en esta versi n de DoxyWizard y cada una de stas varios par metros de configuraci n Wizard Expert Run Topics A Project DOXYFILE_ENCODING UTF 8 Build PROJECT_NAME Messages a PROJECT_NUMBER Input Source Browser PROJECT_BRIEF Index S HTML PROJECT_LOGO JB LaTeX RTF OUTPUT_DIRECTORY Man sen as x CREATE_SUBDIRS PROJECT_LOGO OUTPUT_LANGUAGE English v with the PROJECT_LOGO tag ify ka or icon that is induded in he Di BRIEF_MEMBER_DESC Y The maximum height of the logo should not exceed REPEAT_BRIEF y 55 pixels and the maximum width should not exceed TA NN ru ay Doxygen will copy the logo to the output ABBREVIATE_BRIEF de pS ez The Sname class The Sname widget E The Sname file is x Previous Debido al gran n mero de par metros de configuraci n DoxyWizard proporciona las definiciones de cada uno de stos bajo el combo izquierdo Para visualizar la definici n de alg n par metro de configuraci n simplemente hemos de colocar el puntero del rat n sobre ste SHOW INCLUDE FILES 4 INLINE INFO If the INLINE_INFO tag is set to YES the default FORCE LOCAL_INCLUDES then a tag inline is inserted in the documentation INLINE INFO for inline members SORT_MEMBER_DOCS 3 Run en esta pesta a podremos ejecutar la generaci n del proyecto de documentaci n con los par metros establecidos en cualquiera de los modos anteriores Wizard o Exper
6. disk space Where should Setup place the program s shortcuts Fl Setup will create the program s shortcuts in the following Start Menu folder To continue dick Next If you would like to select a different folder cick Browse Don t create a Start Menu folder En esta ventana se nos pregunta que indiquemos el nombre de la carpeta d nde queremos guardar los componentes instalados que se mostrara en el men Programas de Windows si no deseamos crear 7 004 DOXYGEN una carpeta de men de inicio marcaremos la casilla Don t create a Start Menu folder pulsamos Next para continuar if Setup doxygen Ready to Install Setup is now ready to begin installing doxygen on your computer Click Install to continue with the installation or dick Back if you want to review or change any settings Destination location C Program Files doxygen setup type Full Installation Selected components doxygen Core Installation doxywizard GUI doxygen manual HTML doxygen manual compressed HTML doxygen Example Projects Previo a instalar aparecer una ventana con las opciones de instalaci n que hemos seleccionado en los pasos anteriores Para instalar debemos pulsar el bot n Install Proceder a instalar la aplicaci n con las opciones seleccionadas Please read the following important information before continuing When you are ready to continue with Setup dick
7. en la documentaci n para proyectos de c digo Java usaremos la sintaxis de comentarios de bloques de c digo especificada en JavaDoc Fi Bloque de comentario gd Existen dos formas para a adir descripciones breves a nuestro c digo 1 A adiendo el comando brief todo texto que vaya a continuaci n hasta el final de p rrafo ser la definici n breve La descripci n detallada sigue tras una l nea en blanco brief Descripci n breve de mi clase Contin o con la descripci n breve de mi clase Comienza la descripci n detallada de mi clase gt 2 Si establecemos el par metro de configuraci n JAVADOC AUTOBRIEF YES usaremos el estilo de comentarios de JavaDoc Descripci n breve finaliza en punto Aqu comienza la descripci n detallada y continua Para a adir comentarios referentes a declaraci n de variables el mejor modo es estableciendo el par metro JAVADOC AUTOBRIEF YES y colocar el comentario asi Integer TVal3 lt Variable entera TVal3 Descripci n detallada para TVal3 Esto son simples ejemplos de lo que puede hacer Doxygen para generar un proyecto de documentaci n de c digo fuente evidentemente existen muchas m s opciones y comandos que aportan una gran riqueza a nuestros proyectos para un conocimiento m s a fondo de estos comandos se recomienda visitar la URL de ayuda del autor de Doxygen http www stack nl dimitri doxygen manual html Para proyectos en form
8. isg trivia CasilaPmguntajara 2 psu Ue Trivial 1 Ward e usigi trial Casilallueso jara 2 E B Trivial 1d e usigi tiid Casilla onra jarra o 5 Trivial 1 etusfisg Rial Dado jara o 59 Trivial 1 Wardelusfisg Rida lugadorjawa ooo lt lt lt 58 Trivial 1 Ward os usigi iia Main jara 2 2 2 2 A M Trivial 1 Ward elusfisg Y trial Progurta jara noc BD Trivial 1 Ward e usfisg hiria Tablero jara A GF Trivial 1 Ward e usfisg trivial TabloroFabrica jara A Trivial 1 0 e usfisg trial TipoDoPoagunta jaa 80 Trivial 1 Osr el usfisg riia Trivial jara ooo Bl 3 E A Las pantallas que se muestran son el resultado de haber compilado previamente el archivo refman tex que se encuentra en la subcarpeta lt Directorio de salida doxygen gt latex 23 004 DOXYGEN M todos p blicos a Colection Lasila gt gotldyaconibs i a am wold setidyacentes Cole ction Casilla gt adani s a wold addidyacenta Casilla casilla Atributos del package a Collection Casila gt adyaconibs a de la Clase es us Isg2 trivial TipoDePregunta 004 DIODA CAN ADAPTAR LOS COMENTARIOS DE NUESTRO C DIGO A DOXYGEN Doxygen lee las l neas y bloques de comentarios de nuestro c digo fuente y las a ade al proyecto de az a A ae 4 documentaci n haciendo un buen uso a adiremos descripciones tanto breves como detalladas a nuestras clases m todos funciones y otras partes del c digo Centr ndonos
9. o MikText en la URL http www miktex org 2 9 setup encontraremos una gran variedad de mirrors de descarga tanto para plataformas de 32 como de 64 bits o GhostScript para Win32 http downloads ghostscript com public gs904w32 exe Una vez instalado MikTex y GhostScript en nuestro equipo hemos de asegurarnos que la variable de entorno PATH accede a los directorios donde se encuentran los ejecutables latex exe pdflatex exe y gswin32c exe Para comprobarlo simplemente ejecutaremos una ventana de int rprete de comandos cmd y escribiremos la orden echo path ha de mostrar algo similar a C Program Files gs gs9 04 bin C Program Files MikTex 2 9 MikTex bin en caso contrario han de a adirse las rutas hacia los binarios de GhostScript y MikTex a la variable de entorno PATH Para este manual se han instalado todos los componentes para plataforma Windows excepto la suite Qt SDK con el fin de mostrar las posibilidades de Doxygen 004 DOXYGEN PRIMEROS PASOS Antes de darle uso a Doxygen hemos de tener claro si soporta el lenguaje de programaci n de nuestro proyecto Actualmente Doxygen soporta los siguientes lenguajes C C CH Objective C IDL Java VHDL PHP Python FORTRAN y D Aun as es posible configurar Doxygen para que soporte m s lenguajes de programaci n estableciendo como interpretaci n la de cualquiera de los anteriormente citados MODOS DE USO DE DOXYGEN Doxygen para Windows ofrece dos modos de uso
10. or Expert tab then switch to the Run tab to generate the documentation Select the desired extraction mode Documented entities only All Entities Indude cross eferenced source code in the output Select programming language to optimize the results for Optimize for C output Optimize for C CLI output 9 Optimize for Java or C output Optimize for C or PHP output Optimize for Fortran output Optimize for VHDL output Opciones establecidas en la pantalla anterior OPTIMIZE OUTPUT _JAVA YES EXTRACT_ALL YES SOURCE BROWSER Bo File Settings Help Step 1 Specify the working directory from which doxygen will run C Users JuanCarlos Step 2 Configure doxygen using the Wizard and or Expert tab then switch to the Run tab to generate the documentation Select the output format s to generate HTML 9 plain HTML with navigation panel prepare for compressed HTML chm With search function 9 as intermediate format for hyperlinked PDF as intermediate format for PDF as intermediate format for PostScript Man pages Rich Text Format RTF XML 20 004 DOXYGEN Opciones establecidas en la pantalla anterior GENERATE _ HTML YES GENERATE _ TREEVIEW NO GENERATE _ LATEX YES PDF_HYPERLINKS YES USE_PDFLATEX YES i ayen GUI Fronter a ICT AN EA A File Settings Help m Step 1 Specify the working directory from which doxygen will run Y c Users JuanCarlos
11. 2011 11 21 24 para 004 por alo AY n 004 Portfolio 004 P gina principal Paquetes Clases Q7 Buscar Lista de archivos Lista de archivos Lista de todos los archivos con descripciones breves Trivial 1 0 src es us isg2 database JDBCFacade java c digo Trivial 1 0 src es us isg2 trivial Casilla java c digo Trivial 1 0 src es us isg2 trivial CasillaDado java c digo Trivial 1 0 src es us isg2 trivial CasillaPregunta java c digo Trivial 1 0 src es us isg2 trivial CasillaQueso java c digo Trivial 1 0 src es us isg2 trivial CasilllaCentral java c digo Trivial 1 0 src es us isg2 trivial Dado java c digo Trivial 1 0 src es us isg2 trivial Jugador java c digo Trivial 1 0 src es us isg2 trivial Main java c digo Trivial 1 0 src es us isg2 trivial Pregunta java c digo Trivial 1 0 src es us isg2 trivial Tablero java c digo Trivial 1 0 src es us isg2 trivial TableroFabrica java c digo Trivial 1 0 src es us isg2 trivial TipoDePregunta java c digo Trivial 1 0 src es us isg2 trivial Trivial java c digo Generado el S bado 5 de Noviembre de 2011 11 21 27 para 004 por an VIG em z 3 Ejemplos de pantallas del resultado obtenido en formato LaTex Cap tulo 4 Indice de archivos 41 Lista de archivos Lista de lodos los archivos con descripciones brews Trivial 1 Osroes usfisgY databasa JOB CFacado jara o 57 Trivial 1 Ward e usfisg A trivial Casilallado jaa aa E Trivial 10 sro ea us
12. Doxygen Manual de instalaci n y buenas pr cticas Autor Juan Carlos Serrano V zquez Usuarios Mazin Morabet Chandni Bakhru Anita Bakhru Juan Carlos Serrano V zquez Grupo 20 004 DIODA CAN Lago CIE CIO ieee Poio nn A O O UI EE 3 Obtener Dory e matias 4 dora A A PE EEE A A en 5 Descarga del paquete de instalaci n ccccccessecccesecccccesececeesececeecceeenseceeeuseceeeuecessuecessueeeesenecetsuneeess 5 Otros componentes de instalaci n cccooccnnonccnnnnonacnnonanonnnnarononononononnnonnnnnronnnnncrnnnnannnnonaronnnnnonnnnnaonos 10 APP O o O E EA 11 Modos a A 11 Uso de doxygen bajo l nea de COMANCOS ooccccccnccnncnoccnnnnacnnnonanonnnnnconnnnncnnonananononaronnnnaronenanoninnos 11 Generaci n del fichero de configuraci n oocccccnncnnnonocnnonnnonononacononononnnnnannnonanonnnnnnonnonaronnnnass 12 Configuraci n del proyecto de documentaci n cccccoccnnconccnnonaconnnonacnnnnnannnonaronnnnncnnnnononnnonoss 14 Ejecuci n de Doxygen con nuestro fichero de configuraci n occcccocccnccnonnnononcnnnnnaccnnnanonnnos 15 Uso de doxygen mediante interfaz gr fica ccccooccnconocnnnnononnnonanonnnnncnnnnnannnnonarononononnnnnnnnnonoss 15 Barra de men principal scanner rra 16 rea de pesta as del asistente ceceecesscesscecsesscesceseceresescesecsacssceeaceeaeceasceseeeeeeenseaseeseeneess 16 Un ejemplo de proyecto de COCUMENTACION ccccescccccsseccceeseccccene
13. ME PROJECT_NUMBER 12 DOXYGEN b Creaci n de fichero de configuraci n en formato extendido Doxygen g config doxy Resultado Doxyfile 1 7 5 1 This file describes the settings to be used by the documentation system doxygen www doxygen org for a project All text after a hash is considered a comment and will be ignored The format is TAG value value For lists items can also be appended using TAG value value Values that contain spaces should be placed between quotes SE OSE HH e Project related configuration options This tag specifies the encoding used for all characters in the config file that follow The default is UTF 8 which is also the encoding used for all text before the first occurrence of this tag Doxygen uses libiconv or the iconv built into libc for the transcoding See http www gnu org software libiconv for the list of possible encodings DOXYF TEE _ ENCODING UTF 8 The PROJECT_NAME tag is a single word or sequence of words that should identify the project Note that if you do not use Doxywizard you need to put quotes around the project name if it contains spaces PROJECT_NAME The PROJECT_NUMBER tag can be used to enter a project or revision number This could be handy for archiving the generated documentation or if some version control system is used PROJECT_NUMBER N tese que las l neas precedidas
14. Suite 330 Boston MA 02111 1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed Preamble The licenses for most software are designed to take away your I accept the agreement 5 Ido not accept the agreement Where should doxygen be installed A Setup will install doxygen into the following folder To continue dick Next If you would like to select a different folder cick Browse At least 7 4 MB of free disk space is required En esta ventana seleccionaremos la ubicaci n d nde queremos instalar Doxygen una vez seleccionada hacemos clic en Next En la pr xima ventana seleccionamos las opciones de instalaci n Doxygen ofrece tres tipos Full completa opci n que aparece por defecto instala los componentes b sicos la interfaz gr fica manual en HTML y HTML comprimido y ejemplos de uso 6 004 DOXYGEN Minimum m nima s lo instala los componentes b sicos Custom personalizada ofrece la opci n de seleccionar los componentes que deseamos instalar excepto los componentes b sicos que ya est n preseleccionados 2 y tela oy Setup doxygen Select Components Which components should be installed Select the components you want to install dear the components you do not want to install Click Next when you are ready to continue doxygen Example Projects Current selection requires at least 7 4 MB of
15. ato HTML Las descripciones breves son usadas para generar Tooltips 25
16. ceceunececeuecececeueceseueceseuecesseneceetsuneseeees 19 Adaptar los comentarios de nuestro c digo a DOXYBON cccoocccccnnccncnnccnnnnnconnnonacononononnnnnonnnonanonnnnnncnnonanonnnns 25 004 DO CAN INTRODUCCI N Doxygen es un sistema de generaci n de documentaci n para c digo fuente de varios lenguajes de programaci n entre los que cabe destacar Java PHP C C CH etc Doxygen es capaz de generar tanto documentaci n online en HTML para usarse a trav s de navegadores web tanto documentaci n offline en Latex tambi n soporta la generaci n de archivos RTF ps pdf e incluso p ginas de manual de Unix Linux Podremos configurar doxygen para extraer la estructura de c digo de ficheros fuentes sin documentar Doxygen se licencia bajo los t rminos de licenciamiento de GNU para m s informaci n visite la web http www gnu org licenses old licenses gpl 2 0 html 004 DOXYGEN OBTENER DOXYGEN La ultima version de Doxygen es la 1 7 5 1 la cual podemos obtenerla tanto en codigo fuentes cOmo en binarios ejecutables para distintas plataformas doxygen 1 7 5 1 src tar gz Linux x86_64 compilado para Ubuntu 10 10 con kernel 2 6 35 y gcc 4 4 5 FTP HTTP No dispone de interfaz gr fica Windows xP Vista 7 32 ts 2 Mac OSX 10 4 Tiger 004 DO CAN INSTALACI N Para ste manual he optado por explicar el proceso de instalaci n bajo plataforma Windows 1 ya que de ste modo obtenemos directamente la inter
17. e que a continuaci n se detallan cada bloque a su vez cada bloque se subdivide en varios bloques la navegaci n entre los bloques la realizamos con los botones Previous y Next 1 Wizard v ase la figura anterior es el modo m s sencillo de generar un proyecto de documentaci n simplemente rellenando y o marcando las opciones que m s nos interesen seremos capaces de generar nuestro proyecto La pesta a Wizard se subdivide en 4 bloques de opciones 16 004 DOXYGEN a Project en este bloque establecemos los par metros b sicos para un proyecto de documentaci n como nombre del proyecto directorio de los fuentes directorio d nde se generar la salida del proyecto etc b Mode b sicamente establecemos las opciones del modo en que se extrae la informaci n desde los ficheros fuentes y para qu tipo de lenguaje optimizamos la salida c Output formatos en los que deseamos generar la documentaci n Diagrams opciones referentes a la generaci n de gr ficas de los diagramas de clases 17 2 Expert para usuarios m s avanzados este bloque muestra muchas m s opciones de configuraci n que el modo Wizard podemos realizar ajustes m s finos para nuestro proyecto de documentaci n Al igual que en el modo anterior se ha subdividido en varios bloques de modo que se agrupan las distintas opciones de configuraci n en funci n del tipo
18. faz gr fica y una mayor facilidad de uso DESCARGA DEL PAQUETE DE INSTALACI N Obtenemos nuestro paquete de instalaci n de la URL http ftp stack nl pub users dimitri doxygen 1 7 5 1 setup exe Una vez descargado en nuestro equipo ejecutamos el instalador fa Ejecutar como administrador Solucionar problemas de compatibilidad E Tra Si el usuario que instala el paquete no dispone de privilegios de Administrador debemos ejecutar dicho paquete haciendo clic con el bot n derecho del rat n y pulsando la opci n Ejecutar como administrador A continuaci n aparecer un asistente de instalaci n Welcome to the doxygen Setup Wizard This will install doxygen 1 7 5 1 on your computer Itis recommended that you dose all other applications before Click Next to continue or Cancel to exit Setup 1 r z A g Las capturas de im genes realizadas se han hecho con Windows 7 de modo que usuarios de otras plataformas de Windows soportadas podr n apreciar ciertas diferencias de aspecto 004 DOXYGEN Para continuar debemos hacer clic en Next Seguidamente aparecer una ventana donde constan los t rminos de licencia i Setup doxygen Please read the following important information before continuing Please read the following License Agreement You must accept the terms of this GNU GENERAL PUBLIC LICENSE Version 2 June 1991 Copyright C 1989 1991 Free Software Foundation Inc 59 Temple Place
19. figFile Laled doxygen w latex headerFile footerFile styleSheetFile configFil Use doxygen to generate an rtf extensions file RIF doxygen e rtf extensionsFile 3 is specified the comments in the config file will be omitted configName is omitted Doxyfile will be used as a default Pasos basicos para un uso correcto de Doxygen mediante linea de comandos 1 Generar un fichero de configuraci n del proyecto 2 Configuraci n del proyecto de documentaci n 3 Ejecuci n de Doxygen con nuestro fichero de configuraci n GENERACI N DEL FICHERO DE CONFIGURACI N Antes de ejecutar Doxygen hemos de generar un fichero de configuraci n ste contendr todas las opciones que deseemos establecer para nuestro entorno de trabajo y o proyecto Para crear dicho fichero ejecutaremos Doxygen s g lt fichero de configuraci n gt donde fichero de configuraci n ser el nombre del fichero que generar doxygen para configurar el entorno de trabajo y el conjunto de opciones que deseemos Nota el par metro s es opcional a adi ndolo hacemos que doxygen genere un fichero de configuraci n en formato corto sin las definiciones de los par metros Ejemplos a Creaci n de fichero de configuraci n en formato corto Doxygen s g config doxy Resultado Doxyfile 1 7 5 1 a A EE A ps cg pp a a EE EEEE cg A ag E EE Project related configuration options E AAA A A A A ee DOXYFILE_ENCODING UTF 8 PROJECT NA
20. ice MikTeX 2 9 de Notepad L SecureW 7 4 Atras Con las opciones que se seleccionaron anteriormente el instalador ha generado lo siguiente Documentaci n en formato HTML ubicada en el sistema de ficheros del equipo del usuario modo offline Doxywizard interfaz gr fica de doxygen puede funcionar tanto en modo avanzado usuarios expertos como en modo asistente Ejemplos Paquete de desinstalaci n para eliminar Doxygen de nuestro equipo 004 DOXYGEN OTROS COMPONENTES DE INSTALACI N Doxygen con la finalidad de mejorar el aspecto de los gr ficos y aumentar las posibilidades de generaci n de ficheros de salida se recomienda la instalaci n de GraphViz 2 20 O superior Podemos descargarlo desde la URL http www graphviz org pub graphviz stable windows graphviz 2 28 0 msi dicho paquete posee la herramienta dot la cual generar gr ficos m s atractivos Microsoft HTML Help Workshop s lo bajo Windows para la generaci n de ficheros de salida en formato HTML compilado Podemos descargarlo desde la URL http www microsoft com download en details aspx displaylang en amp id 21138 Qt SDK para generar ficheros de ayuda comprimidos en formato Qt Desde la URL http at nokia com downloads tendremos acceso a todos los componentes de la suite de desarrollo Qt MikTex y GhostScript para generar ficheros en formato PDF o el uso de f rmulas cient ficas mediante LaTex
21. n gt De este modo se generar la documentaci n con nuestros par metros de configuraci n que figuran en dicho fichero USO DE DOXYGEN MEDIANTE INTERFAZ GR FICA Es probable que pueda parecer un poco tedioso el modo de trabajo anteriormente descrito Doxygen ofrece para plataformas Windows y Mac OSx una interfaz gr fica en modo de asistente con la cual pr cticamente sin muchos conocimientos profundos de la aplicaci n podremos generar proyectos de documentaci n bastante tiles y atractivos Para arrancar dicha interfaz ejecutaremos Inicio gt Programas gt Doxygen gt DoxyWizard Nos mostrar una ventana como la que figura a continuaci n File Settings Help Step 1 Specfy the working directory from which doxygen wil run Step 2 Configure doxygen using the Wizard and or Expert tab then switch to the Run tab to generate the documentation Wizard Expert Run Topics Provide some information about the project you are documenting Project Mode Project name Output Diagrams Project synopsis Project version or id Project logo Specify the directory to scan for source code Source code directory Select E Scan recursively Specify the directory where doxygen should put the generated documentation Destination directory Previous De este modo disponemos de una interfaz grafica muy amigable con la que podemos no solo generar proyectos de documentaci n ademas nos ofrece la po
22. por el s mbolo quedan como comentarios y no establecen cambio alguno al fichero de configuraci n 13 004 DOXYGEN CONFIGURACI N DEL PROYECTO DE DOCUMENTACI N Una vez creado el fichero con cualquiera de los formatos hemos de editarlo para establecer las opciones de nuestro proyecto de documentaci n Para ello abriremos el archivo con cualquier editor de texto por ejemplo Notepad A continuaci n se mencionar los par metros b sicos de configuraci n para generar un proyecto de documentaci n PROJECT_NAME lt Nombre del proyecto de documentaci n gt PROJECT_NUMBER lt N mero del proyecto de documentaci n gt PROJECT BRIEF lt Descripci n breve del proyecto documentaci n gt PROJECT_LOGO lt Logotipo para el proyecto gt QUTPBOT_ DIRECTORY lt Directorio donde se guardar la documentaci n generada gt OUTPUT_LANGUAGE English lt Lenguaje en que se nos mostrar el proyecto gt OPTIMIZE_OUTPUT_JAVA YES lt Indica si deseas optimizar la documentaci n del proyecto de documentaci n para c digo fuente Java gt IA AAA A SAA PE configuration options related to the input files EE VENEEN NE PENE A A EEE Sa ae ne Pe gr A A een ee ee eee INPUT lt Ruta donde se encuentra el c digo fuente gt FILE PATTERNS lt Patr n de los ficheros ej Java gt RECURSIVE NO lt Indicamos si busca ficheros en la ruta de forma recursive si nuestro proyecto tiene m s de un directorio se recomienda establecer YES g
23. sibilidad de guardar las configuraciones de los proyectos generados en ficheros A continuaci n se detalla cada una de las partes de la interfaz 004 DOXYGEN BARRA DE MEN PRINCIPAL amp Doxygen GUI frontend E File Settings Help La barra de men nos ofrece las siguientes opciones e File Open permite abrir un fichero de configuraci n guardado Open recent muestra una lista con los ficheros de configuraci n que se guardaron recientemente o Save guarda la configuraci n en el fichero actual o Save as permite guardar la configuraci n actual de la interfaz en un fichero o Quit cierra Doxygen e Settings o Reset to factory defaults carga los valores de configuraci n por defecto o Use settings at startup establece los valores de configuraci n establecidos por el usuario al arrancar Doxygen o Clear recent list elimina el listado de configuraciones recientemente guardadas e Help Ayuda online de Doxygen REA DE PESTA AS DEL ASISTENTE Wizard Expert Run Bes Provide some information about the project you are documenting Project Mode Project name Output Diagrams Project synopsis Project version or id Specify the directory to scan for source code Source code directory E Scan recursively Specify the directory where doxygen should put the generated documentation Destination directory Previous El area de pesta as se divide en tres grandes bloqu
24. t EXCLUDE lt Indicamos los ficheros o directorios que se excluyen para la documentaci n gt E AE A configuration options related to the HTML output RERE ESEE e E ee GENERATE_HTML YES lt Indicamos si deseamos generar documentaci n en format HTML gt E AE A ES a E ee A configuration options related to the LaTeX output A E a A A A A E E EEE E GENERATE_LATEX YES lt Indicamos si deseamos generar documentaci n en format LaTex gt A AAA A Configuration options related to the dot tool A A a eee ee eee CLASS DIAGRAMS diagramas de clases gt HAVE_DOT i NO lt Indicamos si disponemos de la herramienta de generaci n de gr ficos gt YES lt Indicamos si deseamos que nos genere los Para un conocimiento m s a fondo de los distintos par metros de configuraci n se recomienda visitar la web del manual del autor de Doxygen en la URL http www stack nl dimitri doxygen manual html 2 as e ze A a Si hemos instalado la Suite de generaci n de gr ficos GraphViz y deseamos generar el diagrama de clases de forma visual estableceremos el valor del par metro a YES 14 004 DOXYGEN EJECUCI N DE DOXYGEN CON NUESTRO FICHERO DE CONFIGURACI N Una vez realizado todos los pasos anteriores estamos en disposici n de generar nuestro primer proyecto de documentaci n de c digo fuente con Doxygen es muy sencillo basta con ejecutar desde el int rprete de comandos Doxygen lt fichero de configuraci
25. t En esta pesta a figuran los siguientes botones de comandos a Run doxygen genera la documentaci n en los formatos establecidos y la guarda d nde hubi ramos indicado en los par metros de salida b Show configuration muestra los par metros de configuraci n que se han establecido para el proyecto que se est generando c Save log permite guardar en un fichero lo que aparezca en el cuadro de salida principal de sta pesta a es decir si hemos pulsado show configuration guardar 004 DOS CAN dicha salida si tras haber ejecutado run doxygen pulsamos save log guardar los mensajes que se generan en la compilaci n del proyecto d Show HTML Output visualiza en el navegador web por defecto la documentaci n en formato HTML Run doxygen Status not running Show configuration Save log Output produced by doxygen Show HTML output La siguiente figura muestra un ejemplo de salida de un proyecto de documentacion en formato HTML lt A E CAUsers JuanCarlos Desktop 004 html inherits htm P x ia E 004 Jerarqu a de la clase 004 Portfolio 004 AA P gina principal Paquetes Clases Q7 Buscar Lista de clases ndice de clases Jerarqu a de la clase Miembros de las clases Jerarqu a de la clase Ir a la jerarqu a textual de la clase es us isg2 database JDBCFacade es us isg2 database JDBCFacade ResultSetlterator es us isg2 trivial CasillaDado es
26. us isg2 trivial CasillaPregunta m es us isg2 trivial Casilla es us isg2 trivial CasillaQueso es us isg2 trivial CasilllaCentral gt a F 18 004 DOS CAN UN EJEMPLO DE PROYECTO DE DOCUMENTACI N Para el siguiente ejemplo vamos a generar la documentaci n del proyecto Trivial visto en clase de pr cticas y generaremos la salida tanto en formato HTML y LaTex aaa qur0 0 amp Doxygen GUI frontend C Users JuanCarlos config doxy File Settings Help Step 1 Specify the working directory from which doxygen will run C Users JuanCarlos Step 2 Configure doxygen using the Wizard and or Expert tab then switch to the Run tab to generate the documentation Provide some information about the project you are documenting Project name 004 Project synopsis Project version or id Piet Specify the directory to scan for source code abi fa Scan recursively Specify the directory where doxygen should put the generated documentation Destination directory Desktop 004 select Previous Opciones establecidas en la figura anterior PROJECT_NAME 004 PROJECT_NUMBER 1 PROJECT_BRIEF Portfolio 004 OUTPUT_DIRECTORY Desktop 004 INPUT Trivial 1 0 19 004 DOXYGEN Doxygen GUI frontend C Users JuanCarlo Step 1 Specify the working directory from which doxygen will run C Users JuanCarlos Step 2 Configure doxygen using the Wizard and
Download Pdf Manuals
Related Search