Schwierigkeiten/Fragen bei der Benutzung von PHPDocumentor

Hi,

ich hab heute mal die ersten Versuche mit PHPDocumentor gemacht und
dabei ein paar größere Probleme gefunden.

- Ich habe jede PHP Klasse in einer eigenen Datei. PHPDocumentor will
aber für jede Datei ein Page Block und dann den Block für die Klasse.
Nun ist es aber für mich völlig sinnfrei den Block einfach doppelt zu
definieren. Daher gibt es eine Möglichkeit, dass PHPDocumentor den Block
der Klasse als Page Block nimmt?

- PHPDocumentor erstellt im Menü Links zu Klassen, Methoden usw. aber
auch zu den Quellcodedateien. Dies ist für mich unnötig und ich hätte
dies gerne draußen. Geht das?

z.B.
Files:
ExceptionConstants.php
Interfaces:
ExceptionConstants

- Dann noch eine Frage, gibt es einen Tag, mit dem ich kennzeichnen
kann, dass eine Methode eine bestimmte Exception wirft?

Danke schon mal für die Hilfe. :)

--
Mit freundlichen Grüßen,
Christoph Herrmann

http://dragonprojects.de/
Christoph Herrmann [ Mi, 26 September 2007 17:55 ] [ ID #1829927 ]

Re: Schwierigkeiten/Fragen bei der Benutzung von PHPDocumentor

Christoph Herrmann schrieb:
> ich hab heute mal die ersten Versuche mit PHPDocumentor gemacht und
> dabei ein paar größere Probleme gefunden.
>
> - Ich habe jede PHP Klasse in einer eigenen Datei. PHPDocumentor will
> aber für jede Datei ein Page Block und dann den Block für die Klasse.
> Nun ist es aber für mich völlig sinnfrei den Block einfach doppelt zu
> definieren. Daher gibt es eine Möglichkeit, dass PHPDocumentor den Block
> der Klasse als Page Block nimmt?
>
> - PHPDocumentor erstellt im Menü Links zu Klassen, Methoden usw. aber
> auch zu den Quellcodedateien. Dies ist für mich unnötig und ich hätte
> dies gerne draußen. Geht das?
>
> z.B.
> Files:
> ExceptionConstants.php
> Interfaces:
> ExceptionConstants

Zwei Fliegen mit einer Klappe geschlagen. Ich kann einfach einen kleinen
Page Block definieren mit einer Packageangabe. Danach erstell ich die
Dokumentation ohne dieses Package, welches ich für alle Page Blöcke
benutzt habe.

Hat den Vorteil, dass die Links für die .php Dateien alle in einem
Package sind (bei mir "Sourcefiles") und ich diese auch ganz weglassen
kann. Dadurch hab ich in den anderen Packages keinerlei Verlinkungen auf
Dateien mehr (Ausnahme sind Dateien ohne Klassen, Funktionen, Interfaces).

Aber eine neue Frage stellt sich dabei, kann ich die Einstellungen des
PHPDocumentor speichern, sodass ich nicht immer wieder Input- und
Outputverzeichnis sowie die Liste der Packages einstellen muss?

--
Mit freundlichen Grüßen,
Christoph Herrmann

http://dragonprojects.de/
Christoph Herrmann [ Mi, 26 September 2007 19:45 ] [ ID #1829931 ]

Re: Schwierigkeiten/Fragen bei der Benutzung von PHPDocumentor

Also sprach Christoph Herrmann:

> Aber eine neue Frage stellt sich dabei, kann ich die Einstellungen des
> PHPDocumentor speichern, sodass ich nicht immer wieder Input- und
> Outputverzeichnis sowie die Liste der Packages einstellen muss?

Das sollte doch theoretisch mit den Konfigurationsdateien (user/*.ini) zu
machen sein. Dann brauchst Du nur noch die entsprechende Konfigdatei aus der
Drop-Down-Liste auswählen und alles läuft automatisch. Theoretisch, wie
gesagt. Denn ich bekomme immer die Meldung "a target file must be
specified", obwohl ich ein solches m.M.n. doch sehr wohl in der Konfigdatei
angegeben habe. Entweder handelt es sich hier um einen Bug oder ich habe
etwas übersehen. Vielleicht weiß hier irgendjemand etwas darüber.

Gruß,
Thomas
Thomas Mlynarczyk [ Mi, 26 September 2007 20:09 ] [ ID #1829932 ]
PHP » de.comp.lang.php.misc » Schwierigkeiten/Fragen bei der Benutzung von PHPDocumentor

Vorheriges Thema: umfangreichere OO-Programmierung
Nächstes Thema: Backslash & Übergabe an mysql