Chciałbym wiedzieć, czy istnieją jakieś dobre techniki do tworzenia / utrzymywania dokumentacji w interfejsie.

Buduję interfejs z kodu c ++ na python za pomocą swig; głównie jestem po prostu% włączając pliki nagłówkowe c ++. Mam do czynienia z co najmniej dziesiątkami klas i 100 funkcji, więc preferowane są narzędzia automatyczne.

W idealnej sytuacji chciałbym użyć komentarzy w formacie doxygen w nagłówkach c ++ do wypełnienia dokumentów w klasach / metodach Pythona.

Alternatywnie, generowanie oddzielnej dokumentacji (w ascii, html ...) byłoby również przydatne. Wygląda na to, że ten rodzaj funkcjonalności był obsługiwany we wcześniejszych wersjach swig (1.3 i wcześniejszych), ale nie widzę sposobu, aby to zrobić z 2.0.

Czy są jakieś przydatne (zautomatyzowane) techniki dokumentowania interfejsu?