[C] Automatisch Api erstellen

[mc_gulasch]

Moin bzw. Mahlzeit Forum,

ich weiß noch aus meinen Java - Zeiten, dass es eine Möglichkeit, einen Code, ein Tool oder was weiß ich was das war, gab, das automatisch ein zu dem Code gehörige API konstruiert hat. Man musste im Code zu den Funktionen Kommentar auf bestimmte Weise angeben und hat dann eine dieser 'übschen Java-APIs im HTML - Format bekommen (wie man sie halt so kennt). Jetzt wollt ich mal wissen, ob es sowas für C auch gibt? Ich entwickle (leider) mit MS VC++ 6.0, falls es da was für gibt. Alternativen natürlich auch erlaubt

Danke sagt das Gulasch

 

[GABehnke]

Hmm,
wenn ich Dich richtig verstanden habe, möchtest Du eine Software schreiben, die Funktionen bzw. Methoden anderen zur Verfügung stellt.
Da hast Du unter Windows zwei Möglichkeiten.
1.) Eine DLL. Hierbei nach Möglichkeit nur C Standardtypen übergeben. Also z.B. als Rückgabewert statt eines CStrings den typ char*.
2.) Eine COM Schnittstelle. Die kann auch z.B. in Deiner .exe enthalten sein.

Gruß
Gerhard

 

[deepthroat]

Hi.

Ich würde dir dafür doxygen empfehlen.

Das funktioniert wie das von dir angedeutete javadoc Tool, nur unterstützt nicht nur Java sondern auch C/C++ und ein paar andere Sprachen.

Gruß

 

[GABehnke]

Hmm,

doxygen ist meines Wissens nach eine Software zur Erstellung einer Dokumentation aus dem Quelltext. Unter API habe ich immer ein ApplikationsInterface verstanden ?!

Gruß
Gerhard

 

[deepthroat]

doxygen ist meines Wissens nach eine Software zur Erstellung einer Dokumentation aus dem Quelltext. Unter API habe ich immer ein ApplikationsInterface verstanden ?!

Ja, er möchte aber eine Dokumentation seiner API (Application Programming Interface) für seine Bibliothek/sein Programm haben:

und hat dann eine dieser 'übschen Java-APIs im HTML - Format bekommen (wie man sie halt so kennt). Jetzt wollt ich mal wissen, ob es sowas für C auch gibt?

Er möchte also eine Doku im HTML Format wie es auch von javadoc generiert wird, hat sich aber nicht ganz so glücklich ausgedrückt.

Gruß

/edit: Übrigens programmiert er wenn ich mich recht erinnere unter Linux - und da kann er mit DLLs und mit COM nichts anfangen. /edit2: Da hab ich wohl etwas verwechselt - mit Visual C++ 6 unter Linux entwicklen? pfffffft... Zeit Feierabend zu machen.

 

[jokey2]

@deepthroat:

Ich entwickle (leider) mit MS VC++ 6.0

Nur als Hinweis ;-)

Sonst vermute ich, Du hast recht (mit der Doku), aber vielleicht äußert sich mc_gulasch selber mal dazu.

@mc_gulasch: Mahlzeit

 

[deepthroat]

@deepthroat:

Nur als Hinweis ;-)

Ja, hab ich gesehen. Aber das ist doch völlig Wurscht, oder nicht?! Doxygen läßt man einfach über die Quelldateien rutschen und gut is'.

Aber hab grad bei codeproject ein Add-In für VC++ 6 gefunden: http://www.codeproject.com/macro/Method_Doc.asp

Der Autor wollte eine neue Version mit Doxygen Unterstützung in den nächsten Tagen bereitstellen.

Gruß

 

[mc_gulasch]

@all

Deepthroat hat mich schon richtig verstanden. Doxygen it is. Das mit MSVC war nur ein Hinweis, falls es sowas bereits integriert gibt.

Das Add-In hört sich gut an. Werde die Sachen mal austesten. Vielen Dank auf jeden Fall.

//edit:

Der Autor wollte eine neue Version mit Doxygen Unterstützung in den nächsten Tagen bereitstellen.

Hab grad festgestellt, dass diese Kommentar vom Autor leider schon von 6:13 29 Mar '04 ist

 

[deepthroat]

Hab grad festgestellt, dass diese Kommentar vom Autor leider schon von 6:13 29 Mar '04 ist

Oh ja. Da hab ich mich total im Datum vertan. Da wird wohl kaum mehr etwas passieren.

Ist aber auch nicht so tragisch, man kann die Dokumentations-Tags ja auch per Hand einfügen.

Gruß