Seite 1 von 1

Übersicht über die Code-Module

BeitragVerfasst: Sa 20. Mär 2010, 18:02
von Josef Pötzl
Hallo!

Wie könnte man eine Übersicht über die Code-Module gestalten, die eine Suche nach Funktionalität ermöglicht?

Derzeit ist nur eine Doxygen-Doku der Code-Module im Repository enthalten.

mfg
Josef

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 10:31
von Sten Schmidt
Im Endeffekt sind in der Doxygen-Doku ja alle Informationen enthalten...

Unter [1] gibt es oben rechts eine Suchfunktion, fragt sich nur, ob die in Doxygen nur aktiviert werden muss oder ob das was externes ist.

[EDIT]

Es gibt ein Flag "SEARCHENGINGE" für die Doxygen-Config, siehe [2].

[/EDIT]

[1] http://www.vtk.org/doc/nightly/html/index.html
[2] http://www.doxygen.nl/config.html#cfg_searchengine

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 13:00
von Josef Pötzl
Auf diese Einstellung hatte ich ganz vergessen. :)

Für die Dateien im SVN-Repostiory aktivierte ich nun die Client-Suche.
Beispiel: https://svn.access-codelib.net/svn/code ... index.html

Für eine Volltextsuche ist php erforderlich. Das bekomme ich aber in SVN nicht zum Laufen.
=>Dann bleibt vermutlich nichts anderes übrig, als die Doku auch auf den Webserver zu verlegen.
Beispiel: http://source.access-codelib.net/doc/
Die Webserver-Variante hat zwar den Nachteil, dass die Dateien nicht unter Versionskontrolle stehen. Man kann also darin immer nur die aktuelle Version abrufen. Allerdings kann man sich ja für jede gewünschte Version die chm-Hilfe lokal speichern und darin suchen.

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 13:10
von Andreas Vogt
Hallo,
könnte man die Übersichtsgrafik der Code-Module nicht klickbar machen? dass man dann direkt in die Klassenreferenz kommt?
Ich könnte dir dazu die usemap mit meinem Editor erstellen.

Andreas

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 13:28
von Josef Pötzl
Hallo!

Ich erstelle die Grafik mit Graphviz. Damit kann man auch map-Einträge ausgeben lassen (Beispiel). Ich muss allerdings mein Add-In noch etwas anpassen, damit das funktioniert.
Ein manuelles Erstellen der map-Einträge ist mir zu mühsam. ;)

mfg
Josef

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 14:39
von Andreas Vogt
Hallo,
sowas erstellt mal ja nicht manuell, sondern es gibt ein eingebautes Tool beim HomeSite HTML Editor.

Hier die erstellte usemap, die Links fehlen:

Code: Alles auswählen
<map name="codelib">
<area alt="ApplicatenHandler_AppFile" coords="212,158,364,183" href="">
<area alt="ApplicationHandler" coords="188,299,297,324" href="">
<area alt="WinApiShortCutMenu" coords="642,51,761,77" href="">
<area alt="AppLogin_Win" coords="6,411,191,435" href="">
<area alt="DirTextbox" coords="176,448,345,473" href="">
<area alt="Stoppuhr" coords="630,392,710,415" href="">
<area alt="TempDBHandler" coords="328,511,423,537" href="">
</map>
<img src="...codelib.jpg" width="800" height="542" border="0" usemap="#codelib">


Gruß Andreas

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 14:50
von Josef Pötzl
Da müsste man dann aber die Links anpassen, damit sie zu den Doxygen-Dateien passen. ;)
Ich erweitere nun mein Add-In. Damit sollte es (bis auf ein paar Layout-Unschönheiten) einigermaßen klappen.
=> http://source.access-codelib.net/doc/

/EDIT: Die Darstellung mit Graphviz wurde mittlerweile aus der Doku entfernt, da sie bei mehreren Klassen zu unübersichtliche wird.

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 17:13
von Andreas Vogt
Klasse, so macht das Navigieren mehr spass!

Gruß und Danke
Andreas

Re: Übersicht über die Code-Module

BeitragVerfasst: So 21. Mär 2010, 18:17
von Josef Pötzl
Die Doku ist folgendermaßen erreichbar:
Stammstruktur: http://source.access-codelib.net/doc/
Entwicklungszweig: http://source.access-codelib.net/doc/draft/

Anm.: In den Webserver-Varianten funktioniert nun auch die Volltextsuche.