modul.ordner.docunator_class_docgenerate.php

AUTOR: Andreas Theusner, © 2009 - ansatheus@gmx.net - http://www.ansatheus.de
PROGRAMM: AT Contenator
DATEI: modul.ordner.docunator_class_docgenerate.php
ZWECK: - Klasse für die Erzeugung der Dokumentation - erbt von der HTML-Klasse
EINBINDUNG: require_once("modul.ordner.docunator_class_docgenerate.php");
  $html = new html; - neue Instanz
WICHTIG: durch obige Einbindung erfolgt die Initialisierung der Klasse, die wichtig ist, denn
  der direkte Aufruf der Funktionen klappt nicht immer
FUNKTIONSAUFRUF: alle beschriebenen Aufrufarten gelten für alle Funktionen, außer dem Konstruktor
  $ergebnis = $docgenerate->function(Parameter) - Instanz
  $ergebnis = docgenerate::function(Parameter) - direkt
  $ergebnis = $this->function(Parameter) - in der Klasse
LIZENZ: GNU General Public License
  Dieses Programm ist freie Software. Sie können es unter den
  Bedingungen der GNU General Public License, wie von der Free
  Software Foundation veröffentlicht, weitergeben und/oder
  modifizieren, entweder gemäß Version 2 der Lizenz
  Die Veröffentlichung dieses Programms erfolgt in der Hoffnung,
  daß es Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE,
  sogar ohne die implizite Garantie der MARKTREIFE oder der
  VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie
  in der GNU General Public License.
 
  Sie sollten eine Kopie der GNU General Public License zusammen
  mit diesem Programm erhalten haben. Falls nicht, schreiben Sie
  an die Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

NAME: function docgenerate()
ZWECK: Konstruktor
AUFRUF: siehe Dateikopf
PARAMETER:
BEMERKUNG:

NAME: function generate($datei_array)
ZWECK: Ausgangsfunktion für die Generierung der Dokumentation
AUFRUF: siehe Dateikopf
PARAMETER: $datei_array = Array mit den Dateien, die nach DocTags geparst werden sollen
BEMERKUNG: ausgehend von dieser Funktion wird der gesante Prozeß der Generierung hier angestoßen

NAME: function parse_line($content)
ZWECK: parst den Inhalt einer Zeile und gibt ihn formatiert zurück
AUFRUF: siehe Dateikopf
PARAMETER: $content = Zeile
BEMERKUNG: damit das funktioniert, muß folgendes Format eingehalten werden
  Tilde-Leerzeichen-DocTag:-Leerzeichen-Beschreibung | Bsp: ~ AUTOR: Andreas Theusner

NAME: function dateinamen_extrahieren($pfaddatei)
ZWECK: extrahiert den Dateinamen
AUFRUF: siehe Dateikopf
PARAMETER: $pfaddatei = enthält den Dateinamen samt kompletten Pfad
BEMERKUNG: extrahiert für Verlinkung in der Dokumentation

NAME: function sort_dateien($array_dateien)
ZWECK: sortiert ein Array, welches die Dateien samt kompletten Pfad enthält nur nach
  den Dateinamen, der sich ganz rechts an letzter Stelle befindet und gibt das
  sortierte Array zurück
AUFRUF: siehe Dateikopf
PARAMETER: $array_dateien = enthält alle Dateinamen samt kompletten Pfad
BEMERKUNG: für aufsteigende Sortierung des Menüs

NAME: function dateiarten_extrahieren($array_dateien,$array_dateiarten)
ZWECK: extrahiert aus einem Dateiarray die anzeigbaren Dateiarten
  und gibt das so erzeugte Array zurück
AUFRUF: siehe Dateikopf
PARAMETER: $array_dateien = enthält alle Dateinamen samt kompletten Pfad
  $array_dateiarten = enthält alle anzeigbaren Dateiarten
BEMERKUNG:

- Generiert mit dem Docunator am 2009-06-25 -