Manual de Instalación y Buenas Prácticas

8/19/2019 Manual de Instalación y Buenas Prácticas

1/28

Autor: Juan Carlos Serrano Vázquez.Usuarios:Mazin Morabet.Chandni Bakhru.Anita Bakhru.


2/28

DOX!"#

CONTENIDO

$ntrodu%%i&n...............................................................................................................'

Obtener Do()*en.......................................................................................................'

$nstala%i&n.................................................................................................................+

Des%ar*a del ,aquete de instala%i&n......................................................................+

Otros %o-,onentes de instala%i&n......................................................................./

0ri-eros ,asos.........................................................................................................

Modos de uso de do()*en....................................................................................

Uso de do()*en ba1o l2nea de %o-andos....................................................

!enera%i&n del 3%hero de %on3*ura%i&n..................................................4

Con3*ura%i&n del ,ro)e%to de do%u-enta%i&n........................................+

"1e%u%i&n de Do()*en %on nuestro 3%hero de %on3*ura%i&n....................5

Uso de do()*en -ediante inter6az *rá3%a..................................................5

Barra de -en7 ,rin%i,al...........................................................................8

9rea de ,estaas del asistente................................................................;

Un e1e-,lo de ,ro)e%to de do%u-enta%i&n.............................................................<

Ada,tar los %o-entarios de nuestro %&di*o a Do()*en...........................................48

INTRODUCCIÓN

4


3/28

DOX!"#

Do()*en es un siste-a de *enera%i&n de do%u-enta%i&n ,ara %&di*o 6uente de=arios len*ua1es de ,ro*ra-a%i&n> entre los que %abe desta%ar: Ja=a> 0?0> C> C@@>C> et%.

Do()*en es %a,az de *enerar tanto do%u-enta%i&n online en ?M ,ara usarse a

tra=Es de na=e*adores Feb> tanto do%u-enta%i&n oGine en ate(> ta-biEn so,ortala *enera%i&n de ar%hi=os .HI> .,s> .,d6 e in%luso ,á*inas de -anual de Uni(inu(.

0odre-os %on3*urar do()*en ,ara e(traer la estru%tura de %&di*o de 3%heros6uentes sin do%u-entar.

Do()*en se li%en%ia ba1o los tEr-inos de li%en%ia-iento de !#U> ,ara -ásin6or-a%i&n =isite la Feb htt,:FFF.*nu.or*li%ensesoldKli%enses*,lK4./.ht-l

OBTENER DOXYGEN

'

http://www.gnu.org/licenses/old-licenses/gpl-2.0.htmlhttp://www.gnu.org/licenses/old-licenses/gpl-2.0.html


4/28

DOX!"#

a 7lti-a =ersi&n de Do()*en es la .;.5. la %ual ,ode-os obtenerla tanto en%&di*o 6uentes %&-o en binarios e1e%utables ,ara distintas ,lata6or-as.

C&di*o 6uente LC@@

do()*enK.;.5..sr%.tar.*z I0 ?0

Binarios

Linux x86_64 L%o-,ilado,ara Ubuntu /./ %onkernel 4.8.'5 ) *%%K+.+.5

No dispone de inter!"#r$%&!

I0 ?0

'indo(s X)*+ist!*, L'4

Bits

I0 ?0

-!& O.X /016 2.no(Leop!rd3

I0 ?0

-!& O.X /014 2Ti#er3 I0 ?0

+

ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.src.tar.gzhttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.src.tar.gzftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.linux.bin.tar.gzhttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.linux.bin.tar.gzftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exehttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exeftp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.7.5.1.dmghttp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.7.5.1.dmgftp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.5.7-tiger.dmghttp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.5.7-tiger.dmgftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.src.tar.gzhttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.src.tar.gzftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.linux.bin.tar.gzhttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1.linux.bin.tar.gzftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exehttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exeftp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.7.5.1.dmghttp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.7.5.1.dmgftp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.5.7-tiger.dmghttp://ftp.stack.nl/pub/users/dimitri/Doxygen-1.5.7-tiger.dmg


5/28

DOX!"#

IN.TLCIÓN

0ara Este -anual he o,tado ,or e(,li%ar el ,ro%eso de instala%i&n ba1o ,lata6or-aNindoFs )a que de Este -odo obtene-os dire%ta-ente la inter6az *rá3%a ) una

-a)or 6a%ilidad de uso.

D"SCAH!A D" 0AU"" D" $#SAAC$P#

Obtene-os nuestro ,aquete de instala%i&n de la UH:htt,:6t,.sta%k.nl,ubusersdi-itrido()*enK.;.5.Ksetu,.e(e

Una =ez des%ar*ado en nuestro equi,o> e1e%uta-os el instalador

Si el usuario que instala el ,aquete no dis,one de ,ri=ile*ios de Ad-inistrador>debe-os e1e%utar di%ho ,aquete ha%iendo %li% %on el bot&n dere%ho del rat&n ),ulsando la o,%i&n Q"1e%utar %o-o ad-inistradorR.

A %ontinua%i&n a,are%erá un asistente de instala%i&n.

as %a,turas de i-á*enes realizadas se han he%ho %on NindoFs ;> de -odo queusuarios de otras ,lata6or-as de NindoFs so,ortadas ,odrán a,re%iar %iertasdi6eren%ias de as,e%to.

5

http://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exehttp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.5.1-setup.exe


6/28

DOX!"#

0ara %ontinuar debe-os ha%er %li% en Q#e(tR.

Se*uida-ente a,are%erá una =entana donde %onstan los tEr-inos de li%en%ia.

0ara %ontinuar debe-os a%e,tar di%hos tEr-inos ) ha%er %li% en Q#e(tR.

8


7/28

DOX!"#

"n esta =entana sele%%ionare-os la ubi%a%i&n d&nde quere-os instalar Do()*en>una =ez sele%%ionada ha%e-os %li% en Q#e(tR.

"n la ,r&(i-a =entana sele%%iona-os las o,%iones de instala%i&n> Do()*en o6re%etres ti,os:

K Iull L%o-,leta: o,%i&n que a,are%e ,or de6e%to> instala los %o-,onentesbási%os> la inter6az *rá3%a> -anual en ?M ) ?M %o-,ri-ido ) e1e-,los

de uso.K Mini-u- L-2ni-a: s&lo instala los %o-,onentes bási%os.K Custo- L,ersonalizada: o6re%e la o,%i&n de sele%%ionar los %o-,onentes

que desea-os instalar> e(%e,to los %o-,onentes bási%os que )a están,resele%%ionados.

;


8/28

DOX!"#

"n nuestro %aso se ha sele%%ionado la instala%i&n %o-,leta> ,ulsa-os Q#e(tR ,ara%ontinuar.

"n esta =entana> se nos ,re*unta que indique-os el no-bre de la %ar,eta d&ndequere-os *uardar los %o-,onentes instalados> que se -ostrara en el -en7Q0ro*ra-asR de NindoFs> si no desea-os %rear una %ar,eta de -en7 de ini%io>-ar%are-os la %asilla QDont %reate a Start Menu 6olderR> ,ulsa-os Q#e(tR ,ara%ontinuar.

T


9/28

DOX!"#

0re=io a instalar a,are%erá una =entana %on las o,%iones de instala%i&n que he-ossele%%ionado en los ,asos anteriores. 0ara instalar debe-os ,ulsar el bot&nQ$nstallR.

0ro%ederá a instalar la a,li%a%i&n %on las o,%iones sele%%ionadas.

Una =ez 3nalizada la instala%i&n se -ostrará una =entana %o-o en la 3*uraanterior> en ella a,are%e in6or-a%i&n a%er%a de los enla%es de des%ar*a ein6or-a%i&n sobre Do()*en> listas de %orreo ,ara los desarrolladores ) usuarios deDo()*en e in6or-a%i&n ,ara el re,orte de errores. 0ara %ontinuar ,ulsa-os Q#e(tR.

A %ontinua%i&n a,are%e una =entana %o-o la si*uiente indi%ando que la instala%i&nse ha realizado %on E(ito.


10/28

DOX!"#

0ulsa-os QIinishR ,ara %errar la =entana.

ras todos estos ,asos he-os instalado Do()*en en nuestro equi,o. 0ara a%%eder al-en7 de instala%i&n he-os de a%%eder al -en7 de ,ro*ra-as de NindoFs.

Con las o,%iones que se sele%%ionaron anterior-ente> el instalador ha *enerado losi*uiente:

K Do%u-enta%i&n en 6or-ato ?M> ubi%ada en el siste-a de 3%heros delequi,o del usuario> -odo oGine.

K Do()Fizard: inter6az *rá3%a de do()*en> ,uede 6un%ionar tanto en -odoa=anzado Lusuarios e(,ertos %o-o en -odo asistente.

K "1e-,los.

K 0aquete de desinstala%i&n: ,ara eli-inar Do()*en de nuestro equi,o.

/


11/28

DOX!"#

OHOS COM0O#"#"S D" $#SAAC$P#

Do()*en %on la 3nalidad de -e1orar el as,e%to de los *rá3%os ) au-entar las,osibilidades de *enera%i&n de 3%heros de salida> se re%o-ienda la instala%i&n de:

K Gr!p5+i" 10 o su,erior. 0ode-os des%ar*arlo desde la UHhtt,:FFF.*ra,h=iz.or*,ub*ra,h=izstableFindoFs*ra,h=izK4.4T./.-sidi%ho ,aquete ,osee la herra-ienta QdotR la %ual *enerará *rá3%os -ásatra%ti=os.

K -i&rosot 7T-L 7ep 'or9s5op Ls&lo ba1o NindoFs ,ara la *enera%i&nde 3%heros de salida en 6or-ato ?M %o-,ilado. 0ode-os des%ar*arlodesde la UH htt,:FFF.-i%roso6t.%o-doFnloadendetails.as,(dis,la)lan*enWid4'T

K :t .D; ,ara *enerar 3%heros de a)uda %o-,ri-idos en 6or-ato t. Desdela UH htt,:qt.nokia.%o-doFnloads tendre-os a%%eso a todos los%o-,onentes de la suite de desarrollo t.

K -i9Tex < G5ost.&ript ,ara *enerar 3%heros en 6or-ato 0DI o el uso de6&r-ulas %ient23%as -ediante ae(.

o Mike(t: en la UH htt,:FFF.-ikte(.or*4. ha de -ostrar al*o si-ilar aC:\Program Files\gs\gs9.04\bin;C:\Program Files\MikTex 2.9\MikTex\bin;

en %aso %ontrario han de aadirse las rutas ha%ia los binarios de !hostS%ri,t )Mike( a la =ariable de entorno 0A?.

0ara este -anual se han instalado todos los %o-,onentes ,ara ,lata6or-aNindoFs> e(%e,to la suite t SDY> %on el 3n de -ostrar las ,osibilidades deDo()*en.

http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msihttp://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21138http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21138http://qt.nokia.com/downloads/http://qt.nokia.com/downloads/http://www.miktex.org/2.9/setuphttp://downloads.ghostscript.com/public/gs904w32.exehttp://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msihttp://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21138http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21138http://qt.nokia.com/downloads/http://www.miktex.org/2.9/setuphttp://downloads.ghostscript.com/public/gs904w32.exe


12/28

DOX!"#

)RI-ERO. ).O.

Antes de darle uso a Do()*en he-os de tener %laro si so,orta el len*ua1e de,ro*ra-a%i&n de nuestro ,ro)e%to. A%tual-ente Do()*en so,orta los si*uienteslen*ua1es:

K C> C@@> C> Ob1e%ti=eKC> $D> Ja=a> V?D> 0?0> 0)thon> IOHHA# ) D.

Aun as2 es ,osible %on3*urar Do()*en ,ara que so,orte -ás len*ua1es de,ro*ra-a%i&n> estable%iendo %o-o inter,reta%i&n la de %ualquiera de losanterior-ente %itados.

MODOS D" USO D" DOX!"#

Do()*en ,ara NindoFs o6re%e dos -odos de uso:

K Ba1o l2nea de %o-andos> ,ara usuarios -ás a=anzados.K Con inter6az *rá3%a en -odo de asistente.

USO D" DOX!"# BAJO Z#"A D" COMA#DOS

"n el ,ro%eso de instala%i&n Do()*en ha -odi3%ado la =ariable de entorno 0A?> de-odo que desde %ualquier dire%torio ,ode-os e1e%utar la orden do()*en.

0ara arran%arlo basta %on abrir una =entana de intEr,rete de &rdenes: Inicio ->Ejecutar-> cmd

Si e1e%uta-os do()*en sin nin*7n ,ará-etro Este -ostrará ,or ,antalla la sinta(isde uso.

4


13/28

DOX!"#

0asos bási%os ,ara un uso %orre%to de Do()*en -ediante l2nea de %o-andos:

. !enerar un 3%hero de %on3*ura%i&n del ,ro)e%to.4. Con3*ura%i&n del ,ro)e%to de do%u-enta%i&n.'. "1e%u%i&n de Do()*en %on nuestro 3%hero de %on3*ura%i&n.

!"#"HAC$P# D" I$C?"HO D" CO#I$!UHAC$P#

Antes de e1e%utar Do()*en he-os de *enerar un 3%hero de %on3*ura%i&n> Este%ontendrá todas las o,%iones que desee-os estable%er ,ara nuestro entorno detraba1o )o ,ro)e%to. 0ara %rear di%ho 3%hero e1e%utare-os:

Doxygen –s –g es o,%ional> aadiEndolo ha%e-os que do()*en *enere un3%hero de %on3*ura%i&n en 6or-ato %orto> sin las de3ni%iones de los ,ará-etros.

"1e-,los:

a Crea%i&n de 3%hero de %on3*ura%i&n en 6or-ato %orto:Doxygen –s –g confg.doxy Hesultado:# Doxyfile 1.7.5.1

#-----------------------------------------------------------------------

----

# Project related configuration options

#-----------------------------------------------------------------------

----

DOXYFILE_ENCODING = UTF-8

PROJECT_NAME =

PROJECT_NUMBER =

'


14/28

DOX!"#

....

b Crea%i&n de 3%hero de %on3*ura%i&n en 6or-ato e(tendido:Do()*en \* %on3*.do()Hesultado:# 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 (" ").

#-----------------------------------------------------------------------

----

# 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.

DOXYFILE_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 =

...

#&tese que las l2neas ,re%edidas ,or el s2-bolo quedan %o-o %o-entarios) no estable%en %a-bio al*uno al 3%hero de %on3*ura%i&n.

+


15/28

DOX!"#

CO#I$!UHAC$P# D" 0HO"CO D" DOCUM"#AC$P#

Una =ez %reado el 3%hero %on %ualquiera de los 6or-atos he-os de editarlo,ara estable%er las o,%iones de nuestro ,ro)e%to de do%u-enta%i&n. 0araello abrire-os el ar%hi=o %on %ualquier editor de te(to> ,or e1e-,lo #ote,ad.A %ontinua%i&n se -en%ionará los ,ará-etros bási%os de %on3*ura%i&n ,ara*enerar un ,ro)e%to de do%u-enta%i&n.

PROJECT_NAME =

PROJECT_NUMBER =

PROJECT_BRIEF =

PROJECT_LOGO =

OUTPUT_DIRECTORY =

OUTPUT_LANGUAGE = English

OPTIMIZE_OUTPUT_JAVA = YES

#---------------------------------------------------------------

# configuration options related to the input files

#---------------------------------------------------------------

INPUT =

FILE_PATTERNS =

RECURSIVE = NO

EXCLUDE =

#---------------------------------------------------------------

# configuration options related to the HTML output

#---------------------------------------------------------------

GENERATE_HTML = YES

#---------------------------------------------------------------

# configuration options related to the LaTeX output

#---------------------------------------------------------------

GENERATE_LATEX = YES

#---------------------------------------------------------------

Configuration options related to the dot tool

#---------------------------------------------------------------

CLASS_DIAGRAMS = YES

HAVE_DOT 2 = NO

0ara un %ono%i-iento -ás a 6ondo de los distintos ,ará-etros de %on3*ura%i&n> sere%o-ienda =isitar la Feb del -anual del autor de Do()*en en la UH:htt,:FFF.sta%k.nl]di-itrido()*en-anual.ht-l

4 Si he-os instalado la Suite de *enera%i&n de *rá3%os !ra,hViz ) desea-os*enerar el dia*ra-a de %lases de 6or-a =isual> estable%ere-os el =alor del

,ará-etro a "S.

5

http://www.stack.nl/~dimitri/doxygen/manual.htmlhttp://www.stack.nl/~dimitri/doxygen/manual.html


16/28

DOX!"#

"J"CUC$P# D" DOX!"# CO# #U"SHO I$C?"HO D" CO#I$!UHAC$P#

Una =ez realizado todos los ,asos anteriores esta-os en dis,osi%i&n de *enerarnuestro ,ri-er ,ro)e%to de do%u-enta%i&n de %&di*o 6uente %on Do()*en> es -u)sen%illo> basta %on e1e%utar desde el intEr,rete de %o-andos:

Doxygen

De este -odo se *enerará la do%u-enta%i&n %on nuestros ,ará-etros de%on3*ura%i&n que 3*uran en di%ho 3%hero.

USO D" DOX!"# M"D$A#" $#"HIA^ !H9I$CA

"s ,robable que ,ueda ,are%er un ,o%o tedioso el -odo de traba1o anterior-entedes%rito> Do()*en o6re%e ,ara ,lata6or-as NindoFs ) Ma% OS(> una inter6az *rá3%a>en -odo de asistente> %on la %ual ,rá%ti%a-ente sin -u%hos %ono%i-ientos,ro6undos de la a,li%a%i&n ,odre-os *enerar ,ro)e%tos de do%u-enta%i&n bastante7tiles ) atra%ti=os.

0ara arran%ar di%ha inter6az e1e%utare-os: $ni%ioK[0ro*ra-asK[Do()*enK[Do()Nizard

#os -ostrará una =entana %o-o la que 3*ura a %ontinua%i&n.

De este -odo dis,one-os de una inter6az *rá3%a -u) a-i*able %on la que,ode-os no s&lo *enerar ,ro)e%tos de do%u-enta%i&n> ade-ás nos o6re%e la

,osibilidad de *uardar las %on3*ura%iones de los ,ro)e%tos *enerados en 3%heros. A%ontinua%i&n se detalla %ada una de las ,artes de la inter6az.

8


17/28

DOX!"#

BAHHA D" M"#_ 0H$#C$0A

a barra de -en7 nos o6re%e las si*uientes o,%iones:

• Iileo O,en: ,er-ite abrir un 3%hero de %on3*ura%i&n *uardado.o O,en re%ent: -uestra una lista %on los 3%heros de %on3*ura%i&n que

se *uardaron re%iente-ente.o Sa=e: *uarda la %on3*ura%i&n en el 3%hero a%tual.o Sa=e as: ,er-ite *uardar la %on3*ura%i&n a%tual de la inter6az en

un 3%hero.o uit: %ierra Do()*en.

• Settin*so Heset to 6a%tor) de6aults: %ar*a los =alores de %on3*ura%i&n ,or

de6e%to.o Use settin*s at startu,: estable%e los =alores de %on3*ura%i&n

estable%idos ,or el usuario al arran%ar Do()*en.o Clear re%ent list: eli-ina el listado de %on3*ura%iones re%iente-ente

*uardadas.

• ?el,: A)uda online de Do()*en.

9H"A D" 0"SA`AS D" AS$S"#"

"l área de ,estaas se di=ide en tres *randes bloque> que a %ontinua%i&n sedetallan> %ada bloque a su =ez %ada bloque se subdi=ide en =arios bloques> lana=e*a%i&n entre los bloques la realiza-os %on los botones Q0re=iousR ) Q#e(tR :

;


18/28

DOX!"#

. 'i"!rd: L=Ease la 3*ura anterior es el -odo -ás sen%illo de *enerar un,ro)e%to de do%u-enta%i&n> si-,le-ente rellenando )o -ar%ando laso,%iones que -ás nos interesen sere-os %a,a%es de *enerar nuestro,ro)e%to. a ,estaa Nizard se subdi=ide en + bloques de o,%iones:

a. 0ro1e%t: en este bloque estable%e-os los ,ará-etros bási%os ,ara un

,ro)e%to de do%u-enta%i&n> %o-o: no-bre del ,ro)e%to> dire%toriode los 6uentes> dire%torio d&nde se *enerará la salida del ,ro)e%to>et%.

b. Mode: bási%a-ente estable%e-os las o,%iones del -odo en que see(trae la in6or-a%i&n desde los 3%heros 6uentes ) ,ara quE ti,o delen*ua1e o,ti-iza-os la salida.

%. Out,ut: 6or-atos en los que desea-os *enerar la do%u-enta%i&n.d. Dia*ra-s: o,%iones re6erentes a la *enera%i&n de *rá3%as de los

dia*ra-as de %lases.

4. Expert: ,ara usuarios -ás a=anzados este bloque -uestra -u%has -áso,%iones de %on3*ura%i&n que el -odo Nizard> ,ode-os realizar a1ustes-ás 3nos ,ara nuestro ,ro)e%to de do%u-enta%i&n. Al i*ual que en el -odoanterior> se ha subdi=idido en =arios bloques> de -odo que se a*ru,an lasdistintas o,%iones de %on3*ura%i&n en 6un%i&n del ti,o de %on3*ura%i&n aestable%er. Con%reta-ente son 8 subdi=isiones en esta =ersi&n deDo()Nizard ) %ada una de Estas =arios ,ará-etros de %on3*ura%i&n.

Debido al *ran n7-ero de ,ará-etros de %on3*ura%i&n> Do()Nizard

,ro,or%iona las de3ni%iones de %ada uno de Estos ba1o el %o-bo izquierdo.0ara =isualizar la de3ni%i&n de al*7n ,ará-etro de %on3*ura%i&n>si-,le-ente he-os de %olo%ar el ,untero del rat&n sobre Este.

'. Run: en esta ,estaa ,odre-os e1e%utar la *enera%i&n del ,ro)e%to dedo%u-enta%i&n %on los ,ará-etros estable%idos en %ualquiera de los -odosanteriores> Nizard o "(,ert. "n esta ,estaa 3*uran los si*uientes botones

de %o-andos:

T


19/28

DOX!"#

a. Hun do()*en: *enera la do%u-enta%i&n en los 6or-atos estable%idos) la *uarda d&nde hubiEra-os indi%ado en los ,ará-etros de salida.

b. ShoF %on3*uration: -uestra los ,ará-etros de %on3*ura%i&n que sehan estable%ido ,ara el ,ro)e%to que se está *enerando.

%. Sa=e lo*: ,er-ite *uardar en un 3%hero lo que a,arez%a en el %uadro

de salida ,rin%i,al de Esta ,estaa> es de%ir> si he-os ,ulsado QshoF%on3*urationR> *uardará di%ha salida si tras haber e1e%utado Qrundo()*enR> ,ulsa-os Qsa=e lo*R *uardará los -ensa1es que se*eneran en la %o-,ila%i&n del ,ro)e%to.

d. ShoF ?M Out,ut: =isualiza en el na=e*ador Feb ,or de6e%to> lado%u-enta%i&n en 6or-ato ?M.

a si*uiente 3*ura -uestra un e1e-,lo de salida de un ,ro)e%to de do%u-enta%i&nen 6or-ato ?M.


20/28

DOX!"#

UN E=E-)LO DE )ROYECTO DE DOCU-ENTCIÓN

0ara el si*uiente e1e-,lo =a-os a *enerar la do%u-enta%i&n del ,ro)e%to ri=ialL=isto en %lase de ,rá%ti%as ) *enerare-os la salida tanto en 6or-ato ?M )ae(.

4/


21/28

DOX!"#

O,%iones estable%idas en la 3*ura anterior:

PROJECT_NAME = 004

PROJECT_NUMBER = 1

PROJECT_BRIEF = "Portfolio 004"

OUTPUT_DIRECTORY = Desktop/004

INPUT = "Trivial 1.0"

4


22/28

DOX!"#

O,%iones estable%idas en la ,antalla anterior:

OPTIMIZE_OUTPUT_JAVA = YES

EXTRACT_ALL = YES

SOURCE_BROWSER = YES

44


23/28

DOX!"#


GENERATE_HTML = YES

GENERATE_TREEVIEW = NO

GENERATE_LATEX = YES

PDF_HYPERLINKS = YES

USE_PDFLATEX = YES


CLASS_DIAGRAMS = YES

HAVE_DOT = YES

CLASS_GRAPH = YES

COLLABORATION_GRAPH = YES

INCLUDE_GRAPH = YES

INCLUDED_BY_GRAPH = YES

CALL_GRAPH = YES

CALLER_GRAPH = YES

4'


24/28

DOX!"#

GRAPHICAL_HIERARCHY = YES


OUTPUT_LANGUAGE = Spanish

"1e-,los de ,antallas del resultado obtenido en 6or-ato ?M:

4+


25/28

DOX!"#

"1e-,los de ,antallas del resultado obtenido en 6or-ato ae(':

' as ,antallas que se -uestran son el resultado de haber %o-,ilado ,re=ia-enteel ar%hi=o re6-an.te( que se en%uentra en la sub%ar,eta Dire%torio de salida

do()*en[late(.

45


26/28

DOX!"#

48


27/28

DOX!"#

D)TR LO. CO-ENTRIO. DE NUE.TRO CÓDIGO DOXYGEN

Do()*en lee las l2neas ) bloques de %o-entarios de nuestro %&di*o 6uente ) lasaade al ,ro)e%to de do%u-enta%i&n> ha%iendo un buen uso aadire-osdes%ri,%iones tanto bre=es +%o-o detalladas a nuestras %lases> -Etodos> 6un%iones) otras ,artes del %&di*o.

Centrándonos en la do%u-enta%i&n ,ara ,ro)e%tos de %&di*o Ja=a> usare-os lasinta(is de %o-entarios de bloques de %&di*o es,e%i3%ada en Ja=aDo%:

/**

* Bo!ue de comentario

*/

"(isten dos 6or-as ,ara aadir des%ri,%iones bre=es a nuestro %&di*o:

. Aadiendo el %o-ando \brief> todo te(to que =a)a a %ontinua%i&n hasta el3nal de ,árra6o será la de3ni%i&n bre=e. a des%ri,%i&n detallada si*ue trasuna l2nea en blan%o:

+ 0ara ,ro)e%tos en 6or-ato ?M as des%ri,%iones bre=es> son usadas ,ara

*enerar oolti,s.

4;


28/28

DOX!"#

/*" #$rie% Descri&ción $re'e de mi case.* (ontin)o con a descri&ción $re'e de mi case.**(omiena a descri&ción detaada de mi case++*/

4. Si estable%e-os el ,ará-etro de %on3*ura%i&n JAVADOCcAUOBH$"I "S>usare-os el estilo de %o-entarios de Ja=aDo%: /** Descri&ción $re'e fnaia en &unto. ,!u comiena a descri&cióndetaada* y contin)a +*/

0ara aadir %o-entarios re6erentes a de%lara%i&n de =ariables> el -e1or -odo esestable%iendo el ,ará-etro JAVADOCcAUOBH$"I "S> ) %olo%ar el %o-entarioas2:

Integer a0 /**< aria$e entera a0. Descri&ción detaada &ara a0. */

"sto son si-,les e1e-,los de lo que ,uede ha%er Do()*en ,ara *enerar un,ro)e%to de do%u-enta%i&n de %&di*o 6uente> e=idente-ente e(isten -u%has -áso,%iones ) %o-andos que a,ortan una *ran riqueza a nuestros ,ro)e%tos> ,ara un%ono%i-iento -ás a 6ondo de estos %o-andos se re%o-ienda =isitar la UH dea)uda> del autor de Do()*en: htt,:FFF.sta%k.nl]di-itrido()*en-anual.ht-l
http://www.stack.nl/~dimitri/doxygen/manual.htmlhttp://www.stack.nl/~dimitri/doxygen/manual.html

Manual de Instalación y Buenas Prácticas

Documents

Transcript of Manual de Instalación y Buenas Prácticas