2013-08-08 6 views
5

Ich habe einige magische Methoden, aber noch Auto-Vervollständigen-Funktionen in Netbeans. ich über alle Klassen einen Block wie:Doxygen ignoriert @ Methode

/** 
* @method int getEavConfigId() get object id 
* @method Model_DbTable_EavConfig setEntityType(string $entity_type) set entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table 
* @method string getEntityType() get entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table 
* @method Model_DbTable_EavConfig setCompanyId(integer $company_id) set company_id 
* @method integer getCompanyId() get company_id 
* @method Model_DbTable_EavConfig setType(string $type) set type possible values textfield, textarea, radio, checkbox, select ; eav field type 
* @method string getType() get type possible values textfield, textarea, radio, checkbox, select ; eav field type 
*/ 

Für Netbeans funktioniert das ziemlich gut. Aber Doxygen scheint es total zu ignorieren.

Hat jemand eine Idee, wenn es möglich ist, doxygen das @ method-Tag zu akzeptieren?

Ich weiß, dass phpDocumentator damit umgehen kann. Aber ich beziehe die Dokumentationen von Doxygen, verursacht durch mehrere Gründe.

+1

* Sie Verbesserungsvorschläge in einreichen [Bug-Tracker] (http://www.stack.nl/~dimitri/doxygen/). Stellen Sie sicher, dass der Schweregrad des Fehlerberichts auf "enhancement" gesetzt ist. * ([Via] (http://www.stack.nl/~dimitri/doxygen/)) - und falls das Lesen von Quellen hilft: https: // github.com/doxygen/doxygen – hakre

+0

@hakre thx, ich öffne ein neues Bug-Tracker-Problem. Hopfully wird es nicht ignoriert werden: https://bugzilla.gnome.org/show_bug.cgi?id=706099 – GreenRover

+0

Netter Bericht würde ich sagen! Auch die Antwort unten sieht nicht schlecht aus. – hakre

Antwort

3

Doxygen hat Ihre Problemlösung bereits implementiert und heißt ALIASES. Die Definition eines Alias ​​sollte in der Konfigurationsdatei mit dem Konfigurations-Tag ALIASES angegeben werden.

Einfache Aliase

Die einfachste Form eines Alias ​​ist eine einfache Substitution der Form

name=value 

Zum Beispiel die Definition der folgenden Alias:

ALIASES += sideeffect="\par Side Effects:\n" 

ermöglicht es Ihnen, die setzen Befehl \ sideeffect (oder @ sideeffect) in der Dokumentation, die zu einem benutzerdefinierten Absatz mit Überschrift Nebenwirkungen führen wird :.

Hinweis, dass Sie \ n's in den Wert Teil eines Alias ​​setzen können, um Zeilenumbrüche einzufügen.

Beachten Sie auch, dass Sie vorhandene spezielle Befehle neu definieren können, wenn Sie möchten.

Einige Befehle, z. B. \ xrefitem, sind für die Verwendung in Kombination mit Aliasen vorgesehen.

Hoffnung das Ihr Problem beheben und für weitere Informationen besuchen DOXYGEN

+0

thx für die Antwort. Aber wenn ich die Dokumentation richtig verstanden habe, kann Alias ​​nicht damit umgehen, wonach ich suche. Weil es bei Aliases nicht möglich ist, real definierte Methoden zu verwenden, wie: 'public function setXyz()' und virtuelle (magische) Methoden wie '@method int getEavConfigId() get object id' im Block" Public Member Functions "zusammengefasst . – GreenRover

+1

Ja, es erzeugt erfolgreich Dokumente, da ich die Attributmethode angegeben habe, um sie als \ fn in der Konfigurationsdatei zu ändern. ALIASES = method = "\ fn" – Vineet1982

+0

Tut mir leid, aber es wird nicht funktionieren. Weil \ fn sein Selbst auch nicht arbeiten wird. Ich habe folgendes Beispiel versucht: '/ *! \ fn Zeichenfolge Model_DbTable_EavConfig :: testTest (Zeichenfolge c, int n) * \ kurze Eine Elementfunktion. * * \ param c eine Zeichenfolge. * \ param n eine ganze Zahl. * \ gibt einen Zeichenzeiger zurück. */' – GreenRover