2 Stimmen

Dokumentieren von automatisch generiertem Code (NSManageObjects) mit Doxygen

Im über zu dokumentieren eine Bibliothek, die ich habe, die NSManageObjects mit Doxygen verwendet. Da NSManageObjects automatisch aus dem Datenmodell generiert werden, wenn ich etwas im Modell ändern, wird die Datei, die das geänderte managedobject enthält, erneut generiert werden.

Ich möchte nicht jedes Mal, wenn eine Änderung am Modell vorgenommen wird, die Dokumentation neu schreiben.

Kennen Sie eine Möglichkeit, dies zu erreichen?

Gracias.

0voto

pdrcabrod Punkte 1467

Ich habe herausgefunden, wie man das erreichen kann. Mit Doxygen können Sie Klassen aus anderen Dateien dokumentieren. Es besteht keine Notwendigkeit, dies in der .h zu tun.

Doxygen analysiert die .h-Datei und erstellt das Dokumentations-Skelett für diese Klasse. Dann können Sie Dokumentation aus jeder anderen benutzerdefinierten Datei hinzufügen.

Das Problem besteht darin, dass Sie einige Labels manuell angeben müssen, um die Informationen aus der .doc-Datei mit der in der .h-Datei deklarierten Klasse zu verknüpfen.

Bitte sehen Sie: Doxygen-Dokumentation an anderen Stellen

und dies: Eigenschaften werden nicht dokumentiert

Das sollte reichen, um eine Vorstellung davon zu bekommen, wie ich es geschafft habe.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X