[Dune] Dune Doku

[Jö Fahlke]

Am Thu, 17. Mar 2005, 10:40:51 +0100 schrieb robertk:
> Am besten wäre es, wenn man eine offizielle Doku hätte (ohne 
> Implementierungen) und dann eine interne für Proger, die halt auch mal 
> mehr wissen möchten. Aber so wie es im Momnet ist, finde ich das Chaos 
> einfach zu gross. Man weiss überhaupt nicht mehr wo vorne und hinten 
> ist. Man könnte das denke ich so machen, dass die offizielle Doku über 
> Netz erreichbar ist (wir müssen auch auf unser Auftreten nach aussen 
> achten) und die interne von jedem selbst generiert werden, mit einem 
> Zusatz parameter oder so was, ich kenne mich bei doxygen da nicht so 
> aus, würde aber erwarten, dass das geht.

Sowas ließe sich vermutlich auf zwei Arten machen:

1. mit den Doxygen Kommandos @cond DEVEL... at encond bzw. @if
   DEVEL... at endif.  Dazu muß man in Doxyfile "ENABLED_SECTIONS =
   DEVEL" setzen.  Damit habe ich allerdings keine Erfahrung.

2. über Präprzessor-Anweisungen #ifdef DOXYGEN_DEVEL...#endif.  Dazu
   setzt man in Doxyfile "PREDEFINED = DOXYGEN_DEVEL".  Das eignet
   sich aber vermutlich besser, um komplexen Code vor Doxygen zu
   verstecken, und Doxygen stattdessen Code zu präsentieren, den es
   besser versteht.

Jö.

-- 
Wie geht die Anmache vom Mathematiker?
"Hey Baby, ich möchtedich transponieren!"