search

wpXtreme / wpdk

WordPress Development Kit
http://wpxtreme.github.io/wpdk/
Other
78 stars 19 forks source link

Doxygen vs phpDocumentor #5

Closed nicolaballotta closed 11 years ago

nicolaballotta commented 11 years ago

Stavo guardandomi la documentazione e come già ho scritto, mi sembra che stiamo andando nella direzione giusta. Quello che continua a non convincermi è il layout, un po' troppo "vecchio". Nonostante Joe sia riuscito a renderlo più che guardarbile rispetto a prima, continua ad avere diversi problemi, primo fra tutti quello di non essere responsive.

Facendomi un giro qua e la, ho trovato questo: http://www.phpdoc.org/

Qualcuno lo conosce?

Mi chiedevo se utilizzasse gli stessi tag di Doxygen, perchè nel caso forse sarebbe da provare. È già responsive di suo, è basato su Bootstrap che ormai conosciamo bene ed è completamente customizzabile.

Ovviamente non è un'urgenza, ma prendiamolo in considerazione, perchè in ottica semplificazione potrebbe essere utile.

gfazioli commented 11 years ago

@nballotta Credo sia una versione nuova rispetto a quella che avevamo valutato tempo addietro. Lascio a @ynoxia valutare l'opportunità di passare a questo nuovo engine, spero che questo non implichi grosse modifiche nel codice già esistente.

ynoxia commented 11 years ago

@nballotta @gfazioli cercate nella vostra posta il thread con subject name PHPDoc vs. Doxygen. L'ultimo messaggio porta la data del 24.08.2012.

Leggete tutti i messaggi. Lì è spiegato perchè usiamo Doxygen invece che PHPDocumentor per la generazione pura e semplice della documentazione.

L'aspetto responsive, e forse la migliore interfaccia grafica, non valgono la potenza di Doxygen. A questo ero arrivato come conclusione dopo aver provato entrambi gli engine.

Se si sceglie di privilegiare l'aspetto grafico alla potenza e alla disponibilità di comandi interni di Doxygen, tenete conto che la documentazione attuale è da riadattare in modo per niente semplice e veloce. Inoltre, phpDocumentor non ha comandi tag che sono stati usati estensivamente nella attuale doc Doxygen compliant, e ne ha altri, in sostituzione, che noi ovviamente non abbiamo mai usato.

gfazioli commented 11 years ago

@ynoxia Si io ricordo quel thread e, a meno che non sia cambiato PHPDoc, concordo nel mantenere Doxygen.

nicolaballotta commented 11 years ago

No beh certo, se c'è da riadattare tutto nada. Per me l'aspetto estetico è molto importante, il responsive in particolare, ma se non si può fare nulla nada!

gfazioli commented 11 years ago

Chiudo... diminuzione entropia :smile: