[suche] VHDL-Dokumentationssoftware

http://engtech.wordpress.com/2006/07/05/inline-source-code-documentation-language-independent/

wiederausgrab
Danke, leider kenne ich den Link schon und er bietet keine Lösung. Ich 
bin mit meiner Suche allerdings auch nicht weitergekommen. Es scheint so 
zu sein, dass das zwar viele Leute brauchen, aber keine freien Lösungen 
verfügbar sind. Schade eigentlich. Zum selber programmieren fehlt mir 
leider die Zeit...

/Chris

Ich hab ein tcl-Skript das mit Xml-Tags im Vhdl-Code in einer Tex Datei 
speichert. Das wäre eine Grundlage, mein skript ist aber noch nicht 
ausgegohren.

Ich habe mich noch nicht so intensiv mit den Interna von Doxygen 
beschäftigt, aber es gibt im Grunde zwei Möglichkeiten neue Sprachen zu 
implementieren.

1) Einen Eingangsfilter, der den Code auf eine bekannte Sprache umbiegt, 
was wohl nur bei eng verwandten Sprachen sinnvoll ist (also z.B. 
Handle-C nach C)

2) Einen eigenen Parser schreiben. Doxygen baut intern auch Bäume, somit 
wäre 123s tcl-Skript ja schon ein guter Ansatz. Klingt nach gar nicht so 
viel Arbeit, aber im Detail liegen die Tücken ;-)

Ich denk der sinnvollste weg wäre die Kommentare im Vhdl-code mit Xml 
tags zu kennzeichnen. Wie das auch in .net in C# möglich ist.
Dann ein Tcl spript zu schreiben das aus den Vhdl-code eine xml datei 
macht, natürlich so dass automatisch die ports , states, variablen und 
signale...
erkennt werden.
Aus der xml datei kann man dann mitels Xsl Html oder auch Latex machen. 
Mir war der weg zu umständlich deshalb habe ich gleich tex daraus 
gemacht. Der mach mir dann PdF's.

> Ich denk der sinnvollste weg wäre die Kommentare im Vhdl-code mit Xml
> tags zu kennzeichnen.

Naja, ich würde vermeiden wollen zig verschiedene Standards zur 
Kommentierung zu nutzen. Die Art wie Doxygen "bedient" wird (\param, 
@param...) finde ich recht praktisch. Da ich auch oft Projekte habe, 
deren Komponenten in mehreren Sprachen entwickelt werden (VHDL, C/C++, 
Java...) finde ich einen konsistenten Kommentarstil sowieso gut. Und ein 
einzelnes Tool, dass man am besten noch per makefile für das ganze 
Projekt scripten kann... herrlich ;-)

Ich schaue mal über Weihnachten tiefer in die Doxygen Sourcen. 
Vielleicht lässt sich ja was einfaches in vertretbarer Zeit auf die 
Beine stellen.

Ich würde es begrüßen, wenn man eine Software hätte, die ohne die 
Präparation der HDL-Sourcen auskäme. Es müsste doch möglich sein, die 
Kommentare so zu erkennen.

http://ghdl.free.fr/features.html

comment
GHDL can also be used to pretty print or to generate cross references in 
HTML. See the dlx example, click on any file and follow the links. For 
more details, see the --pp-html and --xref-html commands in the 
documentation.

> die ohne die Präparation der HDL-Sourcen auskäme. Es müsste doch
> möglich sein, die Kommentare so zu erkennen.

Klar ist das möglich. Das Synthesetool erkennt und ignoriert sie ja auch 
;) Die Frage ist eher, wie man die Zuordnung von Kommentaren zu 
Strukturen hinbekommt.
IMO ist die Mehrarbeit für Kommentare im 
Doxygen-/Javadoc-/wasauchimmer-Stil annähernd null - so man sich daran 
gewöhnt hat.
Abgesehen davon, Doxygen dokumentiert auch unkommentierte Strukturen - 
allerdings nur rudimentär.

> GHDL can also be used to pretty print or to generate cross references
> in HTML.

Bekannt, aber nicht das, was ich suche.

wo steht das, das doxy jetzt auch vhdl kann ?

Da scheint sich nichts zu tun. VHDL ist eine vernachlässigte Sprache. 
Hat auch viel damit zu tun, dass VHDL von Hardwareleuten gemacht wird, 
die oft nichts viel mit Doku am Hut haben und sich das lieber ersparen.