2013-08-08 11 views
5

. ben gibi tüm sınıfları üzerinde bir blok kullanın: netbeans içinDoxygen, bir sihirli yöntem var ancak netbeans'te otomatik tamamlama işlevlerine sahip olmak için @method

/** 
* @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 
*/ 

bu oldukça iyi çalışıyor. Ancak, oksijen yok sayılır.

@method etiketinin kabul edilmesinin mümkün olup olmadığına dair bir fikir sahibi olabilir mi?

phpDocumentator'un bunu işleyebileceğini biliyorum. Ama çeşitli nedenlerden dolayı, doxygen belgelerini öneriyorum.

+1

ziyaret (http://www.stack.nl/~dimitri/doxygen/). Hata raporunun şiddetinin "iyileştirme" olarak ayarlandığından emin olun. * ([Via] (http://www.stack.nl/~dimitri/doxygen/)) - ve okuma kaynaklarının yardımcı olması durumunda: https: // github.com/doxygen/doxygen – hakre

+0

@hakre thx, ben yeni hata izleyici sorunu açın. Umarım göz ardı edilmeyecektir: https://bugzilla.gnome.org/show_bug.cgi?id=706099 – GreenRover

+0

Güzel rapor diyorum! Ayrıca aşağıdaki cevap çok da kötü görünmüyor. – hakre

cevap

3

Doxygen problem çözümünü zaten uygulamış ve ALIASES olarak bilinir. Takma adın tanımı, ALIASES yapılandırma etiketini kullanarak yapılandırma dosyasında belirtilmelidir.

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

sen koymak için izin verecektir:

Basit takma adlar

bir takma ad en basit formu formu aşağıdaki adlandırma tanımlayarak Örneğin

name=value 

basit bir ikamesi olan Belgedeki

Not.

Ayrıca isterseniz mevcut özel komutları yeniden tanımlayabileceğinizi unutmayın.

\ xrefitem gibi bazı komutlar, diğer adlarla birlikte kullanılmak üzere tasarlanmıştır.

Umut bu sorunu çözmek ve Sen [hata takip] içinde geliştirme istekleri gönderebilir * Daha fazla bilgi için DOXYGEN

+0

Cevap için teşekkürler. Ama eğer belgelemeyi doğru anladıysam, diğer adlar aradığım şeyi idare edemez. Çünkü takma adlar ile gerçek tanımlanmış metodlara sahip olması mümkün değildir: 'public function setXyz()' ve sanal (magic) metodları gibi '@method int getEavConfigId() nesne kimliği' 'Public Member Functions' 'komutunda bir araya getirilir. . – GreenRover

+1

Evet, yapılandırma dosyasında \ fn olarak değiştirmek için öznitelik yöntemini verdiğimden dokümanlar başarıyla oluşturuluyor ALIASES = method = "\ fn" – Vineet1982

+0

Üzgünüm ama işe yaramıyor. Çünkü kendisi de işe yaramayacaktır. Şu örneği denedim: '/ *! \ fn dizesi Model_DbTable_EavConfig :: testTest (dize c, int n) * \ kısa Bir üye işlevi. * * \ param c dizesi. * \ bir tam sayı param. * \ bir karakter işaretçisini döndür. */' – GreenRover

İlgili konular