Skip to content
fberci edited this page Feb 23, 2012 · 4 revisions

rövid segédlet a .java fileokból való dokumentáció generálásához

Környezet beállítása

Az Eclipse-ben új Java Project létrehozása, melybe bemásoljuk a latex.java file-t az src mappába. Nálam kezdetben az import-ok nem működtek, mivel nem látta a javadocot a project. Jobb klikk a Projektre > Properties > Java Build Path > Add External JARs..., majd navigáljuk el a java könyvtár /lib/tools.jar fájlhoz. (Nálam: C:\Program Files\Java\jdk1.7.0_03\lib\tools.jar) Properties - External JARs

Generálás beállítása

A megszokott módon a futtatás előtt egy profilt állítsunk be: Run Configurations > Java Application > New Itt ízlés szerint elnevezzük. A Projekt beállítás alatt a Main classhoz írjuk be a javadoc futtató osztály elérését: com.sun.tools.javadoc.Main. Properties - run class

Az Arguments fülön jön a következő beállítás, a dokumentálandó java fájlok kijelölése, ehhez a következő Program argumentet kell bevinni: javadoc -doclet javaToLatex C:\...\*.java. A kódban a latex jelöli ki a lefordított osztály nevét, majd utána a java fájl elérési útját, vagy egy mappában lévő több java fájl együttes kijelölését. Vigyázzunk arra, hogy a mappamegadás nem rekurzív, így ha pl. több package van a projektben, akkor minden egyes package könyvtárát egyesével meg kell adni az argumentumlistában (a sorrend azonban mindegy, mivel az osztályok ABC sorrendben kerülnek megjelenítésre). Properties - arguments

Ezután futtatjuk a projektet a beállítások szerint, majd a konzolból kimásoljuk a ==== CUT HERE ===== és az ==== END CUT HERE ===== közötti részt és bemásoljuk a tex fájlba, remélhetőleg fordítás után mindenki valami hasonlót lát mindenki: Printed PDF

Clone this wiki locally