Forum: PC-Programmierung Doxygen verstehen und Code schreiben


von 0816 (Gast)


Lesenswert?

Ich schlage mich gerade mir einer dokummentierten API rum, die sehr 
umfangreich ist. Darin steht es muss ein set von function pointer 
definitions implementieren und exportiert werden.

Gehe ich auf diese function pointers steht in der Doxygen Datei 
folgendes:

Data structures:
1
struct    dwSensorCommonPluginFunctions

Typedefs:
1
typedef dwStatus(*   dwSensorPlugin_createHandle) (dwSensorPluginSensorHandle_t *handle, dwSensorPluginProperties *properties, const char *params, dwContextHandle_t ctx)

Weiter unten steht dann für dwSensorCommonPluginFunctions:
1
struct dwSensorCommonPluginFunctions:
2
Data Fields:
3
dwSensorPlugin_createHandle |   createHandle
4
...


und für die Typedef : dwSensorPlugin_createHandle
1
typedef dwStatus(* dwSensorPlugin_createHandle) (dwSensorPluginSensorHandle_t *handle, dwSensorPluginProperties *properties, const char *params, dwContextHandle_t ctx)
2
3
Parameters 
4
[out]handle, protperties
5
[in] ctx, params
6
Returns
7
...

Da ich noch nicht an solchen umfangreichen Prigramm gearbeitet habe, ist 
meine Frage was sagt mir das ganze und wie baue ich meinen Code aus 
dieser Doxygen Dokumentation auf?

von Heiner (Gast)


Lesenswert?

0816 schrieb:
> Ich schlage mich gerade mir einer dokummentierten API rum

Ich weiß nicht, warum immer Ratespiele notwendig sind: nVidia Driveworks 
SDK.

https://docs.nvidia.com/drive/driveworks-3.0/index.html

0816 schrieb:
> was sagt mir das ganze

Wenig bis nichts. Die wirkliche Information steht in dem Teil, den du 
hier nicht zitiert hast:

https://docs.nvidia.com/drive/driveworks-3.0/group__sensor__plugins__ext__common__group.html

0816 schrieb:
> wie baue ich meinen Code aus
> dieser Doxygen Dokumentation auf?

Ich halte es für äußerst unwahrscheinlich, dass man sich den praktischen 
Umgang mit dieser API nur über die kommentierten Signaturen aneignen 
kann. nVidia bietet Tutorials:

https://docs.nvidia.com/drive/driveworks-3.0/dwx_tutorials.html

... und Webinare:

https://developer.nvidia.com/drive/training

... und wie immer beginnen Projekte mit einem Mindestmaß an Planung und 
einem grundsätzlichen Verständnis, was man eigentlich tun will, nicht 
mit der Frage, welche Zeiger man wo setzen muss.

0816 schrieb:
> Da ich noch nicht an solchen umfangreichen Prigramm gearbeitet habe

Falls das ein Hobby-Projekt ist: Such' dir was einfacheres für den 
Anfang.

Falls das ein Projekt für Schule/Ausbildung/Studium ist: Die längliche 
Bearbeitungszeit ist unter anderem dafür vorgesehen, sich mit solchen 
Geschichten vertraut zu machen. Es gibt dafür keine Abkürzung.

Falls das ein Projekt im Beruf ist: Kollegen mit Erfahrung um Hilfe 
bitten, Vorgesetzten bitten, die notwendigen Ressourcen zur Einarbeitung 
(Zeit, Schulung, ...) zur Verfügung zu stellen. Falls davon ausgegangen 
wird, dass du das selbst kannst: Keine Sorge, der Personaler wird mit 
dir zusammen gefeuert.

Falls das ein Troll-Versuch ist: Ganz ok, man hätte noch mehr aus der 
Dokumentation hier einkopieren können und die Rechtschreibung hat auch 
noch Raum nach unten.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.