Doxygen-Doku

[Josef Pötzl]

Hallo!

Es sind gar nicht so wenig Klassen und Interfaces vorhanden, wenn man sich die Klassenliste in der Doxygen-Doku ansieht.

mfg
Josef

[Sten Schmidt]

Hi,

würde doxygen dann auch diese Syntax vom Visual Studio mit verarbeiten können?

Code: Alles auswählen


        /// <summary>
        /// Bla bla bla
        /// </summary>
        /// <param name="field">Field with values between first and second value</param>
        /// <param name="value1">first value</param>
        /// <param name="value2">second value</param>
        /// <returns>Where Between Condition</returns>
        public ISqlGenerator WhereBetween(IField field, INumericValue<int> value1, INumericValue<int> value2)
        {
            return Where(new FieldCondition(field, RelationalOperators.Between, new BetweenValue(value1, value2)));
        }
 

[Josef Pötzl]

Ja, man kann die Beschreibung auch manuell z. B. mit XML-Tags erweitern.
Details: http://www.stack.nl/~dimitri/doxygen/xmlcmds.html

[Sten Schmidt]

OK, das scheint ja weitestgehend kompatibel zu sein.
Bleibt nur noch die Sparche zu klären (Deutsch und oder Englisch?).

Nur für die Dokumentation von Beispielen und so allgemeiner "README"-Geschichten ist es .E. nicht geeignet, weil diese Doku hat ja nix mit der Lib als solches zu tun, gehört also nicht direkt in den Source. Was meint Ihr bzgl. der Format-Frage? RTF, HTML? Oder doch lieber alles ins WIKI?

[Josef Pötzl]

Hallo!

Für die allgemeine Projekt-Dokumentation schlage ich das Wiki vor.

Beispiele bzw. die Anleitung zur Verwendung der Bibliothek könnten wir aber auch in Doxygen integrieren. Damit kann man nämlich auch chm-Dateien erzeugen und die Textdateien dafür können z. B. im /doc-Pfad liegen.

Beispiel für chm-Datei: DbmsConnectionWizard.chm

Bezüglich Sparche schlage ich mit Doxygen Deutsch und Englisch vor. Man kann mit Doxygen nämlich unterschiedliche Exportes je Sprache aktivieren.

Im Code-Kommentar würde das dann so aussehen:

Code: Alles auswählen

        /// <summary>
        /// \~german Text in Deutsch
        /// \~english English text \~
        /// </summary>

Damit wird je nach ausgewählter Export-Sprache der passende Eintrag verwendet.

mfg
Josef