Fattigmans modul till Drupal.

20Oct07

Förlåt mig men jag gillar att skapa koddokumentation med Doxygen och jag gillar att ha den lätt tillgänglig. Något som jag har saknat länge är en modul till Drupal för att hantera API/projekt dokumentation. Visst finns det en färdig API modul för Drupal, men den är avsedd för att generera API dokumentation från Drupal projekt. Bristerna i den modulen är alltså att den har väldigt begränsat stöd för doxygen tagar.

Jag vill ha ett system som dynamiskt integrerar doxygen dokumentationen i Drupal. Till att börja med tittade jag lite på möjligheten att importera html filer som var skapade med doxygen, det blev i slutändan väldigt struligt och fult. Med andra ord ingen hållbar lösning, så jag la ner den idéen.

Efter att ha installerat “project” och “project issues tracker” tyckte jag att det var riktigt synd att inte ha något smidigt system för dokumentationen. Att sitta och skriva in dokumentationen för hand gör att dokumentationen inte uppdateras i takt med att man släpper nya versioner.

Lösningen? Jag kodade en fattigmans modul, dvs koden ligger helt eller delvis i en nod på sidan. Jag började egentligen skriva på xml-tolkningen för ett år sedan med lade ner projektet, nu har det alltså återuppstått. Det är inte kul att återta arbetet på 10 månader gammal kod som är odokumenterad och bitvis inte fungerar. Förnärvarande kan jag index.xml, todo.xml och bug.xml. Det finns ingen xml-tolk för att skapa en fulständig API dokumentation förnärvarande, men det kommer. I slutändan är tanken att det ska bli en fulvärdig Drupal modul.

Resultatet kan ni se här

//Fredrik



No Responses Yet to “Fattigmans modul till Drupal.”

  1. Leave a Comment

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s


%d bloggers like this: