Online API Dokumentation

Hier kann alles mögliche diskutiert werden. Themen zu Purebasic sind hier erwünscht.
Flames und Spam kommen ungefragt in den Mülleimer.
Lambda
Beiträge: 526
Registriert: 16.06.2011 14:38

Online API Dokumentation

Beitrag von Lambda »

Suche ein API Dokumentationssystem wie bspw. MSDN. Man soll Vorlagen anlegen können und zum erstellen einer Funktion lediglich ein Formular ausfüllen müssen.

Bin hierzu leider nicht brauchbar fündig geworden. Wichtig ist aber auch, dass mehrere Dokus in diesem System genutzt werden können. Suchanfragen sollen also nur in der aktuell gewählten Doku stattfinden. Der Aufbau sollte, wie gewohnt mit linksseitiger Baumstruktur sein.

lG :)
DarkDragon
Beiträge: 6291
Registriert: 29.08.2004 08:37
Computerausstattung: Hoffentlich bald keine mehr
Kontaktdaten:

Re: Online API Dokumentation

Beitrag von DarkDragon »

Solche Dokumentationen werden größtenteils automatisch aus dem Quelltext generiert, siehe Doxygen, JavaDoc, ... . Meistens schreibt man dazu lediglich einen Kommentarblock vor die Methode/Funktion.
Angenommen es gäbe einen Algorithmus mit imaginärer Laufzeit O(i * n), dann gilt O((i * n)^2) = O(-1 * n^2) d.h. wenn man diesen Algorithmus verschachtelt ist er fertig, bevor er angefangen hat.
Lambda
Beiträge: 526
Registriert: 16.06.2011 14:38

Re: Online API Dokumentation

Beitrag von Lambda »

So gehe ich für die interne Syntax-Hilfe zu, was solche Generatoren allerdings ausgeben ist in den meisten Fällen ein Müllberg. Alle Felder sollten als Plain-Text gespeichert sein, welche dann in ein Template eingesetzt werden. Werde vermutlich einfach selbst das System schreiben. :D Was ich mir vorstelle, was aber nicht simpler sein kann, gibt es scheinbar nicht.
Antworten