mmofacts.com

Doxygen Hilfe

gepostet vor 16 Jahre, 6 Monate von DrakeL
Hi,
ich muss im Zuge eines Projektes eine API Dokumentation im PDF Format aus ein paar C++ Quellcodedateien mit Doxygen generieren.
Kennt sich da jemand aus und wäre so hilfsbereit dies für mich zu machen?
Am besten Kontakt posten oder mir per PM schicken, also ICQ, MSN, Jabber oder IRC oder notfalls halt E-Mail.
Danke im Voraus.
gepostet vor 16 Jahre, 6 Monate von Dunedan
Die Frage die sich mir grade stellt: Wieso machst du das nicht selbst?
gepostet vor 16 Jahre, 6 Monate von DrakeL
Ich habe es einmal mit Doxygen versucht und ehrlich gesagt nicht hinbekommen. Ist zwar schon einige Zeit her, aber derzeit fehlt mir einfach die Zeit dafür um mich da rein zu lesen...
Hab halt gedacht, wenn es jemand kann, kann er die paar Dateien kurz drüber laufen lassen und mir gegebenenfalls bescheid sagen, falls was nicht in Ordnung ist. Ich brauch das Ganze nur einmalig für dieses Projekt derzeit.
gepostet vor 16 Jahre, 6 Monate von Dunedan
Du programmierst C++ und verstehst Doxygen nicht? Respekt.
gepostet vor 16 Jahre, 6 Monate von DrakeL
so sieht es aus C++ entwickle ich beruflich, nur in der Firma wird kaum dokumentiert im Quellcode, also bin ich noch nicht damit in Kontakt getreten. Nur privat mal bisschen, aber da hab ich es dann halt nicht wirklich kapiert.
Also kann mir jemand/kannst du schnell die API Dokumentation meiner 2 Klassen generieren dann als .pdf? ^^
gepostet vor 16 Jahre, 6 Monate von Dunedan
Hättest du die Zeit, die du bisher damit verbracht hast in diesem Beitrag zu schreiben, darauf verwendet dir Doxygen anzugucken wärst du vermutlich schon längst fertig mit deiner Dokumentation.
gepostet vor 16 Jahre, 6 Monate von COrthbandt
Ich hab auch nicht vor, Deine Hausaufgaben zu machen, aber ich werd mal die wesentlichen Options auflisten.
Für Doxygen brauchst Du ein Config-File, hier mal ein Extrakt aus einem unserer Projekte:

PROJECT_NAME = ptLibs
OUTPUT_DIRECTORY = ../doc
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
INPUT = ..\include \
..\src
FILE_PATTERNS = *.c \
*.cpp \
*.h \
*.hpp
RECURSIVE = YES
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
Man _kann_ das natürlich auch anders konfigurieren, aber diese Settings sollten ein Start sein.
gepostet vor 16 Jahre, 6 Monate von Todi42
Bei Doxygen ist sogar eine KlickiBunti Oberfläche zum Erstellen dieser Konfigurationen bei.
gepostet vor 16 Jahre, 6 Monate von DrakeL
Vielen dank für die nicht vorhandene Hilfsbereitschaft... Habe es schon irgendwie befürchtet, dass man eine solche Hilfe nicht bekommt...
gepostet vor 16 Jahre, 6 Monate von COrthbandt
Du erwartest allen Ernstes, dass irgendjemand sich die Zeit nimmt, für Dich die Doxygen-Config zu machen und bist selbst nicht bereit, das in der Tat vorhandene Klickibunti-Tool zu bemühen oder wenigstens mal Copy'n'Paste der angegebenen Minimal-Config zu probieren?
Ist das jetzt Frechheit oder Inkompetenz?
gepostet vor 16 Jahre, 6 Monate von DrakeL
es war einfach eine bitte an jemanden der das Programm kennt und benutzt 2 Klassen durchlaufen zu lassen. Wenn es zuviel Aufwand und Zeit in Anspruch nimmt für jemanden der sich mit dem Programm schon auskennt dann könnt ihr das gerne sagen, dann schreib ich die API Doku lieber von Hand. Dürfte dann schneller gehen als den Zeitaufwand UND die Einarbeitungszeit für mich.
Wie gesagt, wenn jemand bereit wäre die 2 Klassen schnell durch laufen zu lassen möge er sich gerne bei mir melden. Ansonsten entnehme ich deiner Antwort dass der Zeitaufwand wohl zu hoch ist als dass es mir jemand schnell machen würde und es für mich somit schneller geht es schnell selbst zu tippen.
PS: Stimmt, ich habe im Moment nicht die Zeit zu schauen wie dieses Klickibunti Programm funktioniert weil ich es in der Zeit wohl schneller von Hand geschrieben habe und mir das Programm lieber in Ruhe anschaue, wenn ich mal wieder weniger unter Zeitdruck stehe.

Auf diese Diskussion antworten