windows - Hvordan behandler jeg modstridende navne, når du bygger python docs med doxygen

Indlæg af Hanne Mølgaard Plasc

Problem



Jeg har et problem med Doxygen for Windows med Python, hvor inputfiler med samme fejlnavn forårsager en konflikt med outputfiler. Dette ser ud til at være en fejl i doxygen - er der en måde at arbejde rundt på dette problem?





Baggrund


Vi bygger docs til vores API ved hjælp af Doxygen. Vores projekt er overvældende skrevet i python, og de eneste komponenter, som vores kunder bryr sig om, er python. På grund af historiens ulykker har vores klasser ofte uheldige navngivningskonventioner.


For eksempel har vi en klasse, hvis fuldt kvalificerede navn er:


tools.b.foo.Foo
tools.b.bar.Bar


Senere blev denne klasse genimplementeret og sat i et nyt modul:


tools.c.foo.Foo\_improved
tools.c.bar.Bar\_improved


Når vi ønsker at opbygge vores API-dokumentationsværktøjer, har vi en proces, der kontrollerer værktøjer. * I en mappe på build-serveren, og så kalder vi doxygen med en temmelig standard konfigurationsfil.


Vi forventer at der skulle være fire HTML-filer i udgangen, to for foo og to for bar. Men det vi får er kun to filer. Begge sæt af skript er analyseret, men da modulnavne er de samme som dokumentationen for den gamle version slutter med at skrive over den dokumentation, der blev genereret for de nye versioner. Som et resultat i hvert tilfælde, hvor et pythonmodulnavn duplikeres (men i en anden underpakke), får vi kun en enkelt doc-fil for hver filnavn.


FYI, vi bruger doxygen 1.7.1 på Windows XP 32bit med Python 2.4.4


Config-filen er her:
http://pastebin.me/002f3ec3145f4e1896a9cf79e7179493[3]


OPDATERING 1: I den genererede doc-indeks kan jeg se poster for alle fire filer, men hvis jeg følger linkene til både Foo og Foo\_improved, peger begge til den samme fil.

Bedste reference


Du kan prøve at udtrykkeligt erklære en klasse w/fuld navneområde
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdclass[4]