contenido/docs/api Verzeichnis verbessern

Gesperrt
knb
Beiträge: 224
Registriert: Fr 9. Sep 2005, 14:03
Wohnort: Potsdam
Kontaktdaten:

contenido/docs/api Verzeichnis verbessern

Beitrag von knb »

- in contenido/docs/api ein zusätzliches README file anlegen :
darin beschreiben :
wie erzeuge ich meine eigene Contenido API Dokumentation mit doxygen
(doxygen runterladen, am besten lokal installieren, doxy-api.conf datei sichern, kopieren, editieren, doxygen anwerfen, etc.)

- für das eigentliche doxy-api.conf File schlage ich folgende Änderungen vor:

< PROJECT_NAME = "Contenido HEAD API"
---
> PROJECT_NAME = "Contenido API"

< COLLABORATION_GRAPH = YES
---
> COLLABORATION_GRAPH = NO

< UML_LOOK = NO
---
> UML_LOOK = YES

< CALL_GRAPH = NO
---
> CALL_GRAPH = YES



- zweites .conf File mitliefern, welches die Dateien in ../conlib durchforstet und in ein eigenes Output Directory abspeichert. Schliesslich sind die dort abgelegten Klassen auch sehr interessant und dokumentations-würdig.
Hier sind die Änderungen die in das Original doxy-api.conf file einzubauen sind.
(Vorher ist ein contenido/docs/api/conlib verzeichnis anzulegen)
20c20
< PROJECT_NAME = "Contenido HEAD API"
---
> PROJECT_NAME = "Contenido API (conlib directory)"

< INPUT = ../../contenido
---
> INPUT = ../../conlib

< FILE_PATTERNS = *.php
---
> FILE_PATTERNS = *.inc

< HTML_OUTPUT =
---
> HTML_OUTPUT = conlib


< COLLABORATION_GRAPH = YES
---
> COLLABORATION_GRAPH = NO

< UML_LOOK = NO
---
> UML_LOOK = YES

< CALL_GRAPH = NO
---
> CALL_GRAPH = YES
Gruss,
Knut
emergence
Beiträge: 10653
Registriert: Mo 28. Jul 2003, 12:49
Wohnort: Austria
Kontaktdaten:

Beitrag von emergence »

ich verschieb das mal nach bugs...

sollte nicht so ein grosser aufwand sein...
*** make your own tools (wishlist :: thx)
Gesperrt