Forum: PC Hard- und Software Doxygen - Wie Funktionspointertypen von collaboration diagrammen ausschliesen?


von Daniel A. (daniel-a)


Lesenswert?

Ich bin gerade dabei bei einem meiner Projekte (1) etwas Doxygen 
Dokumentation hinzuzufügen (2). Es gibt da zwar so einiges, was sich 
nicht zu machen lassen scheint, aber was mich gerade am meisten stört 
ist wie bei dem "Collaboration diagram" Funktionspointertypen gehandhabt 
werden.
Wenn in einem struct ein anderes struct member ist, wird das schön 
dargestellt, Beispiel: 
https://dpa.li/doc/html/structtym__super__position__rectangle.html#a9dd4a43cdfc3045d620e61e3c39df2d1
Wenn aber ein Funktionspointer drin ist, werden die Typen von dessen 
Argumente, zumindest das erste, leider auch dargestellt: 
https://dpa.li/doc/html/structtym__i__backend.html

Ist es irgendwie möglich, doxygen zu sagen, dass es bei die member mit 
den Funktionspointern oder dessen Argumente in dem Diagramm ignorieren 
soll? Das ist nämlich eher verwirrend als hilfreich, wenn jemand 
nachsehen will wie alles zusammenhängt.

Es gibt noch etwas anderes, was ich eigentlich gerne ändern würde, aber 
vermutlich nicht geht. Im Moment habe ich "EXTRACT_ALL" ausgeschaltet. 
Eigentlich mochte ich es aber, dass alles angezeigt wurde. In 
libttymultiplex.h gibt es aber einige Macros, die von doxygen expandiert 
werden müssen, aber nur innerhalb der lib verwendet werden sollen, und 
ich deshalb in der Doku nicht aufführe n will. Kann man irgendwie nur 
Macros vom "EXTRACT_ALL" ausschliessen, das schien mir leider nicht 
möglich? Ein "\internal" hatte keinen Effekt, bei "\cond" expandiert 
doxygen die nicht mehr, und in "EXCLUDE_SYMBOLS" müsste ich die alle 
einzeln aufführen, weil ein Wildcard leider auch die dokumentierten 
Macros ausschliessen würde. Kann man da irgendwas machen?

1) https://github.com/Daniel-Abrecht/libttymultiplex
2) https://dpa.li/doc/html/

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.