Doxygen dla wielojęzycznego API

Question

Moja firma opracowuje interfejs API do programów inżynierskich. Jest opracowany w C++, ale tworzymy owijarki do niego na następujących językach:

• zastrzeżonym język, który przypomina VB
• MATLAB
• i Python.

Obecnie dokumentacja jest generowana przez kilka skryptów i zaczyna być czasochłonna, aby utrzymać ją w 100%. Zastanawiam się, czy istnieje sposób, aby uzyskać doxygen/sphinx lub inny program do generowania dokumentacji dla C/C++, VB i MATLAB za jednym razem. Część Pythona jest wykonywana przez SWIG. Obecnie produkcja jest coś takiego:

• NameOfFunction
• VB:
• Function NameOfFunction (ByVal As Long, ByRef b() As Long, ByVal C tak długo) Dopóki
• MATLAB:
• wartość = NameOfFunction (a, b() C)
• C/C++
• * wartość NameOfFunction (objtype1 * a, objecttype2 * b * [], Int c)
• + Opis
• + Przykłady

Answer 1

doxygen obsługuje wiele języków,

używać tego na wielu projektów lub folderów i języków wystarczy wskazać doxygen do każdego folderu, który chcesz sprawdzane w config.

Mój ulubiony język programowania to X. Czy nadal mogę używać doxygen?

Nie, nie jako takie; doxygen musi zrozumieć strukturę tego, co czyta. Jeśli nie masz nic przeciwko spędzeniu z nim czasu, istnieje kilka opcji:

Czy obsługiwany jest język X?

Jeśli gramatyka X jest blisko C lub C++, to chyba nie jest zbyt trudne do dostrojenia src/scanner.l trochę więc język jest obsługiwany. Ten jest wykonywany dla wszystkich innych języków bezpośrednio wspieranych przez doxygen (tj. Java, IDL, C#, PHP). Jeśli gramatyka X jest nieco inna niż , możesz napisać filtr wejściowy, który tłumaczy X na coś podobnego do na tyle, aby C/C++ dla doxygen było zrozumiałe (to podejście jest stosowane dla VB, Object Pascal i JavaScript, patrz http://www.stack.nl/~dimitri/doxygen/download.html#helpers). Jeśli gramatura jest zupełnie inna, można napisać parser dla X i napisać backend, który tworzy podobne drzewo składniowe, jak zrobione przez src/scanner.l (a także przez src/tagreader.cpp podczas odczytu plików znaczników).

jednak od twojej użyciu VB jak własność, to może wybrać ten język do góry, jeśli po prostu wystarczy zmienić rozszerzenie pliku, do tego z .Vb

herezje jak go używać z matlab

pytona oraz C++ są już obsługiwane

mieć spojrzenie na F AQ stronie

Answer 2

Witryna Doxygen ma stronę z linkami do pomocników 3rd stron dla różnych języków, które mogą być w stanie dostosować się:

http://www.stack.nl/~dimitri/doxygen/helpers.html

VB i Tutaj wymienione są filtry MatLab.

Answer 3

Zastanawiałem się, czy istnieje sposób, aby uzyskać doxygen/sfinks lub inny program do generowania dokumentacji dla C/C++, VB i Matlab na jednym zamachem.

Edytor Zeus ma doxygen feature, który umożliwia tworzenie dokumentacji doxygen dla wszystkich elementów w obszarze roboczym Zeus.