www.mikrocontroller.net

Forum: PC Hard- und Software suche doxygen_Beispiel-Doku +evtl. source


Autor: Re To (toobatch)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
hallo.

bin davor ein projekt zu dokumentieren (nachträglich).

dachte mir ich nehm doxygen.


nun suche ich mal eine erstellte  gute doku ..  mit relativ viel 
benutzten special-commands .  den quellcode dazu wär auch nicht verkehrt

um mir mal die möglichkeiten doxgens vor augen zu führen  - was mit 
welchen commands ( \xxx)

sehe es nicht für sinnvoll an mir alle special-cmds aus dem manual zu 
erarbeiten.

Autor: Andrew Taylor (marsufant)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
doxygen benoetigt keine grossschreibung oder umlaute. ich finde gut.

Autor: ... (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
also die Bots waren früher auch schon mal besser, dafür aber nie 
angemeldet...

Autor: Re To (toobatch)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
immer schön dummes zeug klopfen !   danke für die hilfe ...

Autor: mano wee (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Ich habe mich vor kurzen auch mit doxygen ein wenig beschäftigt, hab 
dazu eingentlich viel im Netz gefunden...

http://mata.gia.rwth-aachen.de/Manuals/doxygen/htm...

Autor: 123 (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Sorry aber zu doxygen gibt das Netzt genug her. Ein Großteil der open 
source Software ist mit doxygen dokumentiert. Wer da nichts findet ist 
einfach nur faul.

Autor: Frank N. (arm-fan)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
>sehe es nicht für sinnvoll an mir alle special-cmds aus dem manual zu
>erarbeiten.

Kleiner Tipp. Solche Bemerkungen offenkundiger Faulheit kommen hier
im Forum und auch im sonstigen Berufsleben nicht gut an...

Autor: Re To (toobatch)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
ZEIT -  leute ...

wenn man zeit hat dann gehts klar das man ein tag verbringt sich damit 
tief zu beschäftigen .


aber was wenn nicht ...

Autor: ... (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
> immer schön dummes zeug klopfen !   danke für die hilfe ...
Re To , lies dir deine Sätze da oben nochmal durch, dir sollte
auffallen, dass sie nichts mit Rechtschreibung zutun haben und die
Lesbarkeit gegen Null geht, da darfst du eigentlich gar nichts
erwarten. Abgesehen davon, dass so etwas wie Eigeninitiative völlig
fehlt. Das du dafür angeblich keine Zeit hast ist lächerlich, du hast
ja auch Zeit hier auf Antworten zu warten.

Autor: Andrew Taylor (marsufant)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
carpe diem

Autor: Norgan (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
> ZEIT -  leute ...

Klar, deine Zeit ist wichtiger als unsere. Also sollen wir alles fallen 
lassen um dem Herren mal eben eine mundgerechte Kurzeinführungen zu 
bereiten.

Autor: Re To (toobatch)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
@norgan: davon war nie die rede ...   hier muss niemand antworten !

wenn ihr meine frage /mein anliegen überflüssig findet .. dann verdammt 
nochmal antwortet NICHT!  ihr müsst mich hier nicht belehren ...

ist ja furchtbar -  dachte hier geht es ums fach und nicht um die 
perönliche unterhaltung eines jeden von euch

Autor: Karl-heinz Strunk (cletus)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Re To wrote:
> ZEIT -  leute ...
>
> wenn man zeit hat dann gehts klar das man ein tag verbringt sich damit
> tief zu beschäftigen .
>
>
> aber was wenn nicht ...

Dann lässt man's sein.

Alter, bei der Windows-Version gehört sogar ein Tools namens doxywizard 
dazu, da kannst du dir deine Config zusammen klicken.



Achja: Ohne vorher vernünftig im Code kommentiert zu haben bringts das 
nicht.


>ist ja furchtbar -  dachte hier geht es ums fach und nicht um die
>perönliche unterhaltung eines jeden von euch

heul

Schon mal auf den Titel des Forums geachtet?

Da gibt es auch PC-Hard und Software!

Autor: Jörg Wunsch (dl8dtl) (Moderator) Benutzerseite
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Karl-heinz Strunk wrote:

> Alter, bei der Windows-Version gehört sogar ein Tools namens doxywizard
> dazu, da kannst du dir deine Config zusammen klicken.

Bei der Unix-Version auch. ;-)  Ich fand's aber bislang einfacher,
mir die Basiskonfiguration mit doxygen -g zu erzeugen und diese
dann zu editieren.

> Achja: Ohne vorher vernünftig im Code kommentiert zu haben bringts das
> nicht.

Er will ja offenbar wissen, was man alles so in den Code als
Kommentare reinschreibt.  Nur, das alles durchzulesen kann ihm
kaum jemand abnehmen.

Ich könnte noch auf die avr-libc verweisen, die recht umfänglich
damit dokumentiert ist (einschließlich haufenweise separater .dox-
Dateien für codeunabhängige Einleitungen zur jeweiligen Seite, FAQs
etc.), aber das ist nur ein Projekt von vielen, die doxygen
benutzen, und es ist wahrscheinlich eher unüblich, da dort nicht
die projektinterne Dokumentation damit erfolgt, sondern die
Anwenderdoku.

Autor: Jörg Wunsch (dl8dtl) (Moderator) Benutzerseite
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Karl-heinz Strunk wrote:

> Schon mal auf den Titel des Forums geachtet?
>
> Da gibt es auch PC-Hard und Software!

Eben dahin habe ich das jetzt auch geschoben.

Autor: Karl-heinz Strunk (cletus)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Jörg Wunsch wrote:
> Karl-heinz Strunk wrote:

>> Achja: Ohne vorher vernünftig im Code kommentiert zu haben bringts das
>> nicht.
>
> Er will ja offenbar wissen, was man alles so in den Code als
> Kommentare reinschreibt.  Nur, das alles durchzulesen kann ihm
> kaum jemand abnehmen.

Ja, ich fahre da voll drauf ab.

Wenn er eine konkrete Frage hat: Gerne.

"Hey, ich will einen Atmel programmieren: Hat jemand mal ein Beispiel?
Habe keine Zeit mich da einzuarbeiten!"

Zum Schießen ;-)

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.